docs: link to rust items by name #213
Merged
Conversation
This file contains 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
- For items that are in scope, remove the explicit html path. - For items not in scope, link to them by a rust path that does work (e.g. `crate::Watches` or `libc::read`). - Fix incorrect reference `WatchMask::IGNORED` -> `EventMask::IGNORED`. - Replace verbose `[https://some-url/](https://some-url/)` with the equivalent `<https://some-url/>`. This fixes many broken links (some always broken, some only broken on docs.rs), and makes them more robust in the future (rustdoc emits warnings most items that don't resolve.)
hannobraun
approved these changes
Feb 9, 2024
There was a problem hiding this comment.
Thank you, @eric-seppanen, looking good!
I only took a quick look at at the diff and didn't actually test any links. It's getting late here, and if I don't review this now, I'll probably not get to it until some time next week. But whether everything works perfectly or not, this is definitely taking things in the right direction, so I'm happy to merge!
|
It would be good to prevent this from happening again in the future. I've opened #214. |
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.
crate::Watchesorlibc::read).WatchMask::IGNORED->EventMask::IGNORED.[https://some-url/](https://some-url/)with the equivalent<https://some-url/>.This fixes many broken links (some always broken, some only broken on docs.rs), and makes them more robust in the future (rustdoc emits warnings most items that don't resolve.)
Fixes #212.