Add docs for feature flags #333
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
jonhoo
requested changes
Oct 19, 2024
jonhoo
approved these changes
Oct 19, 2024
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.
Addresses #299.
I've added docs for the feature available feature flags. I believe these are correct but as I haven't used this crate myself I'm only going of the code and documentation.
The style is inspired by tracing's feature docs which I consider to be clear and readable. As I understand it there is no standardized format for feature docs yet.
I've not release any crates myself so I'm open to making any changes that would make the docs better or clearer (or correct if I've misunderstood some features).
I picked this up after watching the backlog of streams on the Open Source maintenance and saw that this was yet to be done.