Cleanup rustdoc links#88
Merged
andrewhickman merged 1 commit intoandrewhickman:mainfrom Feb 7, 2026
Merged
Conversation
47d9f71 to
328958b
Compare
andrewhickman
approved these changes
Feb 7, 2026
Owner
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR cleans rustdoc comments, primarily links. No code/API changes.
Don't use http/html links
Why: these are clickable in rust-analyzer and lintable by
rust doc(rustdoc::broken_intra_doc_links):/// Wrapper for [`std::fs::read_dir()`]./// Creates a [`File`] from a raw file and its path./// This struct is created via [`fs_err::read_dir`].These are not:
/// Wrapper for [`fs::read_dir`](https://doc.rust-lang.org/stable/std/fs/fn.read_dir.html)./// Creates a [`File`](struct.File.html) from a raw file and its path.Other changes
seek_wriite.`std::fs::something`, not`fs::something`.`fs_err::Something`, not`crate::Something`.fs-err, not`fs_err`. That's how it's spelled in the readme.