Clean up rustdoc and add doc lint #6044
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
Member
|
Great work 🚀 This is also very helpful for #5981 |
Contributor
Author
|
Thank @waynexia -- hopefully I'll have this PR ready to go shortly |
waynexia
approved these changes
Apr 20, 2023
Member
waynexia
left a comment
There was a problem hiding this comment.
Thanks for this 🎉 I've run it locally and every link looks fine!
| rust-version: stable | ||
| - name: Run cargo doc | ||
| run: | | ||
| export RUSTDOCFLAGS="-D warnings -A rustdoc::private-intra-doc-links" |
Co-authored-by: Ruihang Xia <waynestxia@gmail.com>
Contributor
Author
|
Thank you for the review @waynexia ! |
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.
Which issue does this PR close?
Closes #6042
Rationale for this change
I am trying to get the rustdoc API docs into better shape.
What changes are included in this PR?
cargo docAre these changes tested?
Yes -- new lint
Are there any user-facing changes?
Some broken links in API docs are fixed