improve documentation for optional features #203
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
- new feature `nightly_docs` enables `doc_cfg` unstable feature that allows showing explicit dependencies on features. - new cargo alias `nightly_docs` for a more convenient local documentation build `cargo +nightly nightly_docs --open`. - annotate exported items and implementations depending on some feature with the corresponding `doc(cfg())` attribute. - add the `nightly_docs` feature to the `[package.metadata.docs.rs]` section.
|
I made a commit expanding the |
|
I'm going to just accept this as-is, @zachs18 feel free to do a follow-up PR if you want |
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.
I realized the documentation in docs.rs could benefit by explicitly indicating the items and implementations that depends on which specific features. Please let me know if you want anything done differently. This is the summary of the changes so far:
nightly_docsenablesdoc_cfgunstable feature that allows showing explicit dependencies on features.nightly_docsfor a more convenient local documentation build. E.g.:cargo +nightly nightly_docs --open.doc(cfg())attribute.nightly_docsfeature to the[package.metadata.docs.rs]section.