This repository was archived by the owner on Jan 22, 2025. It is now read-only.
Fix doc tests and examples for Measure::this() #20833
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
Codecov Report
@@ Coverage Diff @@
## master #20833 +/- ##
=========================================
- Coverage 81.9% 81.9% -0.1%
=========================================
Files 496 496
Lines 138317 138409 +92
=========================================
+ Hits 113319 113390 +71
- Misses 24998 25019 +21 |
| /// let (result, measure) = Measure::this(|(arg1, arg2)| my_function(arg1, arg2), ("abc", 123), "my_func"); | ||
| /// # use solana_measure::measure::Measure; | ||
| /// # fn my_function(fizz: i32) -> i32 { fizz } | ||
| /// let (result, measure) = Measure::this(my_function, 42, "my_func"); |
There was a problem hiding this comment.
Perhaps it would be a good idea to have an example of using measure as well. It would be useful in order to demonstrate what exactly the value of measure "means" and how one might use it in the context of a test or benchmark.
There was a problem hiding this comment.
I think that makes sense. I think that would apply more to the actual Measure struct itself, or at the module level. Since this is just for the this() function, I wanted to keep the examples limited to just using this().
dankelleher
pushed a commit
to identity-com/solana
that referenced
this pull request
Nov 24, 2021
frits-metalogix
added a commit
to identity-com/solana
that referenced
this pull request
Nov 24, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Problem
The doc tests in
Measure::this()were ignored since I didn't fully implement them before.Summary of Changes
Fix the doc tests so they are not ignored, and add more/better examples.
Here's what the docs look like now:
