From e4c695501c6e076bc3911e351a23380c22e41749 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Sat, 9 Nov 2024 20:45:05 +0000 Subject: [PATCH] doc(fs): minor tidy up broken links --- src/fs/mod.rs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/fs/mod.rs b/src/fs/mod.rs index 9f82472..3906eae 100644 --- a/src/fs/mod.rs +++ b/src/fs/mod.rs @@ -1,10 +1,10 @@ //! Provides an injectable reference to part of the filesystem. //! -//! Create a new `FileSystem` to access a directory using `kxio::fs::new(path)`. -//! Create a new `TempFileSystem` to access a temporary directory using `kxio::fs::temp()?`; +//! Create a new [FileSystem] to access a directory using [crate::fs::new]. +//! Create a new [TempFileSystem] to access a temporary directory using [crate::fs::temp()]. //! -//! `TempFileSystem` derefs automatically to `FileSystem` so can be used anywhere -//! you would use `FileSystem`. +//! [TempFileSystem] derefs automatically to [FileSystem] so can be used anywhere +//! you would use [FileSystem]. //! //! ``` //! # use std::path::PathBuf; @@ -29,12 +29,12 @@ //! //! # Standard library equivalents //! -//! Given a `FileSystem` `fs`: +//! Given a [FileSystem] `fs`: //! //! ```no_run //! let fs = kxio::fs::temp().expect("temp fs"); // for testing //! // or -//! # let pathbuf = fs.base().join("foo").to_path_buf(); +//! # let pathbuf = fs.base().join("foo"); //! let fs = kxio::fs::new(pathbuf); //! ``` //! @@ -68,7 +68,7 @@ mod system; mod temp; pub use dir_item::{DirItem, DirItemIterator}; -pub use path::{PathReal, PathMarker, FileMarker, DirMarker}; +pub use path::{DirMarker, FileMarker, PathMarker, PathReal}; pub use reader::Reader; pub use result::{Error, Result}; pub use system::{DirHandle, FileHandle, FileSystem, PathHandle};