Simplify doc links#2987
Merged
Merged
Conversation
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
2 participants
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.
I didn't like that some doc links relied on HTML ids in and the page layout of rendered docs. These worked for rendered docs, but not in IDEs like VSCode. This was pretty annoying since I couldn't just just click on them.
This PR uses Rust item paths pretty much everywhere. E.g.
Self::reserveinstead of#method.reserve. This also has the advantage that dev (like me!) don't have to learn 2 syntaxes for links. It's the normal Rust item paths we write every day and not a rustdoc-specific path syntaxI also removed unnecessary references. E.g.
[PngDecoder]: struct.PngDecoder.htmlwhenPngDecoderis in scope.