Skip to content

Commit

Permalink
Small doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
mamcx committed Sep 23, 2024
1 parent 25fbeba commit 4454031
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion crates/platforms/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions crates/platforms/src/directories.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}

Expand Down
8 changes: 2 additions & 6 deletions crates/platforms/src/files.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
Expand Down

0 comments on commit 4454031

Please sign in to comment.