Skip to content

Commit

Permalink
Improve docs for fragment checker
Browse files Browse the repository at this point in the history
  • Loading branch information
mre authored Oct 8, 2024
1 parent af7226e commit 7014765
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lychee-lib/src/utils/fragment_checker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ impl FragmentChecker {
}
}

/// Checks the given path contains the given fragment.
/// Checks if the given path contains the given fragment.
///
/// Returns false, if there is a fragment in the link and the path is to a markdown file which
/// doesn't contain the given fragment.
/// Returns false, if there is a fragment in the link and the path is to a
/// Markdown file, which doesn't contain the given fragment.
///
/// In all other cases, returns true.
pub(crate) async fn check(&self, path: &Path, url: &Url) -> Result<bool> {
Expand Down

0 comments on commit 7014765

Please sign in to comment.