Improve docs for fragment checker

This commit is contained in:
Matthias Endler 2024-10-08 14:55:16 +02:00 committed by GitHub
parent af7226ef2e
commit 7014765988
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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> {