Change documentation of feature flags #639
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
Document the feature flags in the Cargo.toml file instead of a separate file. Keep the old file, but generate the content from the Cargo.toml using the `document-features` crate. The benefit of this approach is that the documentation is stored next to the features. lib.rs has a new feature that reads the documentation from there and shows it as part of the feature list.
Codecov Report
@@ Coverage Diff @@
## master #639 +/- ##
=======================================
Coverage 64.68% 64.68%
=======================================
Files 36 36
Lines 2186 2186
=======================================
Hits 1414 1414
Misses 772 772 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page.
|
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.
Document the feature flags in the Cargo.toml file instead of a separate
file. Keep the old file, but generate the content from the Cargo.toml
using the
document-featurescrate.The benefit of this approach is that the documentation is stored next to
the features. lib.rs has a new feature that reads the documentation from
there and shows it as part of the feature list.
bors r+