refactor(docs): add example to README #23
Merged
Conversation
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
While the current README is very descriptive, some might find the rustdoc to be similarly concise and descriptive of what `trait_variant` should be used for. This commit adds the code example that is used in rustdoc to the README.md which shows up on GitHub and crates.io. Signed-off-by: vados <[email protected]>
tmandry
approved these changes
Jan 4, 2024
|
Thanks! |
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.
While the current README is very descriptive, some might find the rustdoc to be similarly concise and descriptive of what
trait_variantshould be used for.This commit adds the code example that is used in rustdoc to the README.md which shows up on GitHub and crates.io.