Skip to content

Cleanup rustdoc links#88

Merged
andrewhickman merged 1 commit intoandrewhickman:mainfrom
xzfc:rustdoc-links
Feb 7, 2026
Merged

Cleanup rustdoc links#88
andrewhickman merged 1 commit intoandrewhickman:mainfrom
xzfc:rustdoc-links

Conversation

@xzfc
Copy link
Copy Markdown
Contributor

@xzfc xzfc commented Feb 7, 2026

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.
    
  • /// This struct is created via [`fs_err::read_dir`][fs_err::read_dir].
    /// [fs_err::read_dir]: fn.read_dir.html
    

Other changes

  • Fix typo: seek_wriite.
  • Always spell full paths.
    • Use `std::fs::something`, not `fs::something`.
    • Use `fs_err::Something`, not `crate::Something`.
    • Why: extra clear because there are multiple similarly named structures.
  • Refer to the crate as fs-err, not `fs_err`. That's how it's spelled in the readme.

@andrewhickman andrewhickman merged commit c0c63cd into andrewhickman:main Feb 7, 2026
6 checks passed
@andrewhickman
Copy link
Copy Markdown
Owner

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants