From 44540319ed5991594d61563e425dca2825bdf47f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mario=20Alejandro=20Montoya=20Corte=CC=81s?=
 <mamcx@elmalabarista.com>
Date: Thu, 19 Sep 2024 10:08:05 -0500
Subject: [PATCH] Small doc improvements

---
 crates/platforms/Cargo.toml         | 4 +++-
 crates/platforms/src/directories.rs | 4 ++++
 crates/platforms/src/files.rs       | 8 ++------
 3 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/crates/platforms/Cargo.toml b/crates/platforms/Cargo.toml
index a103a4adc69..b6916fc641e 100644
--- a/crates/platforms/Cargo.toml
+++ b/crates/platforms/Cargo.toml
@@ -13,6 +13,8 @@ anyhow.workspace = true
 etcetera.workspace = true
 glob.workspace = true
 serde.workspace = true
-tempfile.workspace = true
 thiserror.workspace = true
 toml.workspace = true
+
+[dev-dependencies]
+tempfile.workspace = true
\ No newline at end of file
diff --git a/crates/platforms/src/directories.rs b/crates/platforms/src/directories.rs
index 0242ee2dce4..489151a950e 100644
--- a/crates/platforms/src/directories.rs
+++ b/crates/platforms/src/directories.rs
@@ -199,9 +199,13 @@ pub struct Directories {
     pub layout: Layout,
     pub home_dir: PathBuf,
     pub root_dir: Option<PathBuf>,
+    /// The `cli-bin-file` file.
     pub bin_file: PathBuf,
+    /// The `cli-bin-dir` directory.
     pub bins_dir: PathBuf,
+    /// The `cli-config-dir` directory.
     pub config_dir: PathBuf,
+    /// The `cli-data-dir` directory.
     pub data_dir: PathBuf,
 }
 
diff --git a/crates/platforms/src/files.rs b/crates/platforms/src/files.rs
index 079ff87906f..ba2a7990e5b 100644
--- a/crates/platforms/src/files.rs
+++ b/crates/platforms/src/files.rs
@@ -55,15 +55,11 @@ pub trait Fs {
     ///
     /// Check the structure of the directories and files, but not create them.
     fn verify_layout(&self) -> Result<(), ErrorPlatform>;
-    /// Create the layout of the file system.
-    ///
-    /// Create the directories and the files that are part of the layout (only)
+    /// Create only the directories and the files that are part of the layout.
     ///
     /// **NOTE:** It doesn't create the files that are part of the data, like logs, replicas, etc.
     fn create_layout(&self) -> Result<(), ErrorPlatform>;
-    /// Load the layout of the file system.
-    ///
-    /// Load the directories and the files that are part of the layout (only)
+    /// Load only the directories and the files that are part of the layout.
     ///
     /// **NOTE:** It doesn't load the files that are part of the data, like logs, replicas, etc.
     fn load_layout(&mut self) -> Result<(), ErrorPlatform>;