Use cargo doc --document-private-items
#4068
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
I think this is what we actually want.
lschuermann
previously approved these changes
Jul 8, 2024
brghena
approved these changes
Jul 8, 2024
|
Is this good to go @bradjc, or are there more changes coming? |
|
All good if it passes CI |
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.
Pull Request Overview
I think when we added
--document-hidden-itemswe really meant to use--document-private-items. This change not only doesn't require an unstable flag, it also generates better docs (fixes #4064) and checks more of our documentation.I had to make a few fixes for cargo doc to succeed on hail.
Testing Strategy
travis
TODO or Help Wanted
n/a
Documentation Updated
/docs, or no updates are required.Formatting
make prepush.