cleaned up formatting

Author: RPG-Alex

src/ast.rs

@@ -17,10 +17,11 @@ pub struct ParsedSqlFile {
 }
 
 impl ParsedSqlFile {
-    /// A parsed SQL file containing DataFusion AST nodes paired with their spans.
+    /// A parsed SQL file containing `DataFusion` AST nodes paired with their
+    /// spans.
     ///
-    /// This struct wraps DataFusion’s `Statement` parsing so we can attach leading
-    /// comments later in the pipeline.
+    /// This struct wraps DataFusion’s `Statement` parsing so we can attach
+    /// leading comments later in the pipeline.
     ///
     /// # Parameters
     /// - `file` is the [`SqlFile`] that will be parsed

src/comments.rs

@@ -249,9 +249,10 @@ impl Comments {
     /// - `file`: the [`ParsedSqlFile`] that needs to be parsed for comments
     ///
     /// # Errors
-    /// - Will return [`CommentError::UnmatchedMultilineCommentStart`] if a comment
-    ///   does not have an opening `/*`
-    /// - Will return [`CommentError::UnterminatedMultiLineComment`] if a multiline comment doesn't end before `EOF`
+    /// - Will return [`CommentError::UnmatchedMultilineCommentStart`] if a
+    ///   comment does not have an opening `/*`
+    /// - Will return [`CommentError::UnterminatedMultiLineComment`] if a
+    ///   multiline comment doesn't end before `EOF`
     pub fn parse_all_comments_from_file(file: &ParsedSqlFile) -> CommentResult<Self> {
         let src = file.content();
         let comments = Self::scan_comments(src)?;

src/docs.rs

@@ -90,7 +90,7 @@ pub struct SqlDocs {
 
 impl SqlDocs {
     /// Create a new instance of [`SqlDocs`]
-    /// 
+    ///
     /// # Parameters
     /// - `tables` the `Vec` of [`TableDoc`] for the struct
     #[must_use]
@@ -102,11 +102,10 @@ impl SqlDocs {
     ///
     /// This merges:
     /// - Parsed SQL AST (`CREATE TABLE` statements for example)
-    /// - Comment spans
-    /// into a format suitable for documentation generation.
-    /// 
+    /// - Comment spans into a format suitable for documentation generation.
+    ///
     /// # Parameters
-    /// - `file`: the [`ParsedSqlFile`] 
+    /// - `file`: the [`ParsedSqlFile`]
     /// - `comments`: the parsed [`Comments`]
     #[must_use]
     pub fn from_parsed_file(file: &ParsedSqlFile, comments: &Comments) -> Self {

src/files.rs

@@ -36,9 +36,10 @@ impl SqlFilesList {
     /// Creates a list of `.sql` files under `path`, optionally excluding files
     /// whose full paths appear in `deny_list`.
     ///
-    /// Paths in `deny_list` must match exactly the `PathBuf` returned by recursion.
-    /// For convenience, the top-level API accepts `&[&str]` instead.
-    /// 
+    /// Paths in `deny_list` must match exactly the `PathBuf` returned by
+    /// recursion. For convenience, the top-level API accepts `&[&str]`
+    /// instead.
+    ///
     /// # Parameters
     ///
     /// - `path`: any type that implements [`AsRef<Path>`].

src/lib.rs

@@ -85,7 +85,7 @@ impl From<ParserError> for DocError {
 /// # Errors
 /// - Will return a `DocError` that  specifies the error (io, comment parsing,
 ///   sql parsing)
-/// 
+///
 /// # Example
 /// ```no_run
 /// use sql_docs::generate_docs_from_dir;
@@ -124,7 +124,7 @@ pub fn generate_docs_from_dir<P: AsRef<Path>, S: AsRef<str>>(
 /// # Errors
 /// - Will return a `DocError` that  specifies the error (io, comment parsing,
 ///   sql parsing)
-/// 
+///
 /// # Example
 /// ```no_run
 /// use sql_docs::generate_docs_from_dir;