Automatically document feature flag requirements on docs.rs by using the feature doc_auto_cfg#266
Open
JSorngard wants to merge 6 commits intobluss:masterfrom
Open
Automatically document feature flag requirements on docs.rs by using the feature doc_auto_cfg#266JSorngard wants to merge 6 commits intobluss:masterfrom
doc_auto_cfg#266JSorngard wants to merge 6 commits intobluss:masterfrom
Conversation
…, and include a link to the stackoverflow page from which the idea is taken
bluss
reviewed
Jul 31, 2024
Owner
|
That looks very good but right now, with the slow speed of development, I don't want to use any unstable features. |
Author
|
Ah, I hadn't seen that! Very nice. Makes sense to not merge. Should I delete the PR, or is it something for the future? |
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
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.
Thanks for the nice crate!
Since this is an unsolicited PR, I completely understand if it is not interesting.
This PR automatically documents all feature flag requirements on docs.rs. This way any future feature flag gated code does not have to worry about documenting what features it needs. It uses the idea discussed in this stackoverflow post.
The feature requires a nightly compiler, but by conditionally enabling it only on docs.rs the MSRV of the crate is unchanged (docs.rs always uses the nightly compiler).
The result should look like this:


and this:
To test it locally you can do
on Linux, and
on Windows.