docs - annotate objects who depend on features #553
Merged
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.
This approach was copied from other crates such as
syn
https://github.com/dtolnay/syn/ where thedoc_cfg
flag is enabled by the compiler when generating docs in order to annotate which feature enables which objects or methods.Try it out
To try out this change a nightly compiler is required (which is used by docs.rs).
However, unrelated to this problem there is a bug in pathfinder which prohibits building with the newest nightly compiler.
A fix is on the way servo/pathfinder#557.
Thus we use a slightly older version
Visit
plotters::prelude
to see some of these annotations and compare with https://docs.rs/syn/latest/syn/.