Update docs on nested metrics #1002
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 #1002 +/- ##
========================================
- Coverage 95% 81% -14%
========================================
Files 179 179
Lines 7652 7652
========================================
- Hits 7263 6186 -1077
- Misses 389 1466 +1077 |
ethanwharris
approved these changes
May 3, 2022
Co-authored-by: Ethan Harris <[email protected]>
Borda
approved these changes
May 3, 2022
Borda
pushed a commit
that referenced
this pull request
May 5, 2022
* Apply suggestions from code review Co-authored-by: Ethan Harris <[email protected]> (cherry picked from commit 6144eb3)
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.
What does this PR do?
Fixes #977
Adds note that we do not recommend nested metrics as it can lead to wrong behaviour in the metric states.
Also adds some missing documentation on the
higher_is_betterproperty.Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃