docs: Auto-document features on docs.rs + improved wording for the top-level documentation #1386
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.
Currently, the
global-contract
feature it hard to discover as while the methods are visible in the docs:There is no indication that
global-contracts
feature is required. Seetokio
as example:To enable this documentation, we just need to enable the nightly feature and hide it behind the conditional compilation flag for docsrs:
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
https://docs.rs/about/builds#detecting-docsrs