Conversation
…tps://docs.rs The documentation currently doesn't expose what features a user needs to enable before certain functionality becomes available, requiring them to look at the sourcecode as we don't really provide much documentation or guideance towards this. That's totally fine because it is a job for `rustdoc`, one that it performs very well when the experimental `doc_cfg` feature is enabled, and specifically `doc_auto_cfg` to not have to manually re-specify every `#[cfg(<guard>)]` within a `#[cfg_attr(docs_rs, doc(cfg(<guard>)))]`. docs.rs builds on `nightly` which makes this possible, and docs can be built with the `docsrs` cfg enabled locally to see the result, e.g.: RUSTDOCFLAGS="-Dwarnings --cfg docsrs" cargo +nightly doc --no-deps --workspace --target aarch64-linux-android --all-features --document-private-items --open
Member
Author
|
The module, for example:
|
20 tasks
msiglreith
approved these changes
Jul 5, 2022
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.
The documentation currently doesn't expose what features a user needs to enable before certain functionality becomes available, requiring them to look at the sourcecode as we don't really provide much documentation or guideance towards this.
That's totally fine because it is a job for
rustdoc, one that it performs very well when the experimentaldoc_cfgfeature is enabled, and specificallydoc_auto_cfgto not have to manually re-specify every#[cfg(<guard>)]within a#[cfg_attr(docs_rs, doc(cfg(<guard>)))].docs.rs builds on
nightlywhich makes this possible, and docs can be built with thedocsrscfg enabled locally to see the result, e.g.: