Clean up documentation

Author: RPG-Alex

rustfmt.toml

@@ -2,6 +2,4 @@ edition = "2024"
 max_width = 100
 use_small_heuristics = "Max"
 reorder_imports = true
-reorder_modules = true
-imports_granularity = "Crate"
-group_imports = "StdExternalCrate"
+reorder_modules = true

src/comments.rs

@@ -207,7 +207,7 @@ impl Comments {
     /// Build all leading comments from a parsed SQL file
     ///
     /// # Parameters
-    /// - `file`: the [`ParsedSqlFile`] that needs to be parsed for comments
+    /// - `file`: the [`ParsedSqlSource`] that needs to be parsed for comments
     ///
     /// # Errors
     /// - Will return [`CommentError::UnmatchedMultilineCommentStart`] if a

src/docs.rs

@@ -175,12 +175,12 @@ impl TableDoc {
         columns.sort_by(|a, b| a.name().cmp(b.name()));
         Self { schema, name, doc, columns, path }
     }
-    /// Getter method for retrieving the table's [`Path`]
+    /// Getter method for retrieving the table's [`std::path::Path`]
     #[must_use]
     pub fn path(&self) -> Option<&std::path::Path> {
         self.path.as_deref()
     }
-    /// Setter for updating the table [`PathBuf`] source
+    /// Setter for updating the table [`std::path::PathBuf`] source
     pub fn set_path(&mut self, path: Option<impl Into<std::path::PathBuf>>) {
         self.path = path.map(Into::into);
     }
@@ -234,7 +234,7 @@ impl SqlFileDoc {
     /// - Comment spans into a format suitable for documentation generation.
     ///
     /// # Parameters
-    /// - `source`: the [`ParsedSqlFile`]
+    /// - `source`: the [`ParsedSqlSource`]
     /// - `comments`: the parsed [`Comments`]
     ///
     /// # Errors

src/source.rs

@@ -31,7 +31,7 @@ impl SqlSource {
     /// Loads a [`SqlSource`] from the given path.
     ///
     /// # Errors
-    /// - Returns an [`io::Error`] if the file cannot be read.
+    /// - Returns an [`std::io::Error`] if the file cannot be read.
     pub fn from_path(path: &std::path::Path) -> std::io::Result<Self> {
         let source = crate::files::SqlContent::from_path(path)?;
         let content = source.content().to_owned();
@@ -49,7 +49,7 @@ impl SqlSource {
     pub fn path(&self) -> Option<&std::path::Path> {
         self.path.as_deref()
     }
-    /// Returns the [`PathBuf`] for the current path
+    /// Returns the [`std::path::PathBuf`] for the current path
     #[must_use]
     pub fn path_into_path_buf(&self) -> Option<std::path::PathBuf> {
         self.path.clone()
@@ -65,7 +65,7 @@ impl SqlSource {
     ///
     /// # Errors
     ///
-    /// Returns an [`io::Error`] if directory traversal fails or if any of the
+    /// Returns an [`std::io::Error`] if directory traversal fails or if any of the
     /// discovered SQL files cannot be read.
     #[cfg(feature = "std")]
     pub fn sql_sources(path: &std::path::Path, deny_list: &[String]) -> std::io::Result<Vec<Self>> {