docs: enrich macro docs with more details/examples#542
Open
rupert648 wants to merge 1 commit intotikv:masterfrom
Open
docs: enrich macro docs with more details/examples#542rupert648 wants to merge 1 commit intotikv:masterfrom
rupert648 wants to merge 1 commit intotikv:masterfrom
Conversation
|
Welcome @rupert648! It looks like this is your first PR to tikv/rust-prometheus 🎉 |
Signed-off-by: Rupert Carr <rupertcarr@hotmail.co.uk>
lucab
reviewed
Mar 19, 2025
| /// | ||
| /// This macro can be used in three ways: | ||
| /// | ||
| /// ``` |
Member
There was a problem hiding this comment.
Here and below, it looks like some doc-tests are failing due to code mismatches (some missing use directives and some wrong API calls).
Can you run a cargo test and fix all the relevant issues?
Member
|
Thanks for the additional docs! |
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
2 participants
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.
Was doing some work with these macros and had a look and decided the docs could use a bit of love. Tried to add more examples and references to other items. Let me know what you think!