doc: restore documentation for hidden items #1553
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
As discussed in rust-lang/rust#67875, there is a difference between 'private' and 'hidden' items. Documenting private is now the default for **bin** crates, but we also want documentation for all of private library crates to be generated as well. Compare: - Before #1546: https://5e23ab06b4899600087c8c17--docs-tockosorg.netlify.com/nrf52/ficr/ - After #1546: https://deploy-preview-1546--docs-tockosorg.netlify.com/nrf52/ficr/ This restores our previous documentation
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
This fixes a bug in documentation building introduced in #1546.
As discussed in rust-lang/rust#67875, there is a
difference between 'private' and 'hidden' items. Documenting private is
now the default for bin crates, but we also want documentation for
all of private library crates to be generated as well. Compare:
This restores our previous documentation
Testing Strategy
Building, a lot, and being confused for a while until I found the right rust issue :).
Documentation Updated
/docs, or no updates are required.Formatting
make formatall.