Skip to content

Commit 98d0a99

Browse files
committed
added documentation for files module
1 parent 5c67278 commit 98d0a99

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/files.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use std::{
88

99
/// A list of SQL files that should be excluded from processing.
1010
///
11-
/// Entries in the deny list are treated as full paths [`PathBuf`]s).
11+
/// Entries in the deny list are treated as full [`PathBuf`] paths.
1212
pub struct DenyList {
1313
deny_files: Vec<PathBuf>,
1414
}
@@ -36,12 +36,12 @@ impl SqlFilesList {
3636
/// Recursively scans `path` for `.sql` files and returns a filtered list.
3737
/// # Parameters
3838
///
39-
/// - `path`: any type that can implement the `AsRef<Path>` trait
40-
/// - `deny_list`: An optional `Vec` of `String` types.
39+
/// - `path`: any type that implements [`AsRef<Path>`].
40+
/// - `deny_list`: optional list of path-like strings representing files to exclude.
4141
///
4242
/// # Errors
4343
///
44-
/// Returns an [`io::Error`] if the file cannot be read.
44+
/// Returns an [`io::Error`] if directory traversal fails.
4545
pub fn new<P: AsRef<Path>>(path: P, deny_list: Option<Vec<String>>) -> io::Result<Self> {
4646
let recursive_scan = recursive_dir_scan(path.as_ref())?;
4747
let allow_list = if let Some(list) = deny_list {

0 commit comments

Comments
 (0)