Skip to content

Commit

Permalink
fix(comments): Our comments were preventing cargo rustdoc from runn…
Browse files Browse the repository at this point in the history
…ing.
  • Loading branch information
Zeioth committed Mar 18, 2024
1 parent d7de32e commit 1c425b8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions selene/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ fn read_config_file() -> Option<(String, Option<PathBuf>)> {
Some((config_contents, config_path))
}

/// Read the config file and return it as Option<(String, &'static Path)>.
/// Read the config file and return it as `Option<(String, &'static Path)>`.
fn parse_config_file_as_string() -> Option<(String, &'static Path)> {
if let Some((config_contents, config_path)) = read_config_file() {
if let Some(path) = config_path {
Expand All @@ -425,7 +425,7 @@ fn parse_config_file_as_string() -> Option<(String, &'static Path)> {
None
}

/// Read the config file and return it as CheckerConfig<toml::Value>, Option<PathBuf>.
/// Read the config file and return it as `CheckerConfig<toml::Value>, Option<PathBuf>`.
fn parse_config_file_as_checkerconfig() -> Option<(CheckerConfig<toml::Value>, Option<PathBuf>)> {
if let Some((config_contents, config_path)) = read_config_file() {
match toml::from_str(&config_contents) {
Expand Down Expand Up @@ -846,4 +846,4 @@ mod tests {

assert!(get_opts_safe(args(vec!["--fail", "files"]), true).is_ok());
}
}
}

0 comments on commit 1c425b8

Please sign in to comment.