Add a semantic warning for printing stats maps with top/div args #1433
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
2 tasks
danobi
reviewed
Jul 22, 2020
suyuee
force-pushed
the
print_stats_map_args_check
branch
from
96b111c to
a608794
Compare
danobi
reviewed
Jul 22, 2020
suyuee
force-pushed
the
print_stats_map_args_check
branch
2 times, most recently
from
4fe5b7f to
98f80d4
Compare
Both `top` and `div` are ambiguous when printing stats maps. `top` does not specify which statistic it's based on and it would cause confusion to define a default behavior for it. As for `div`, it would also somehow be strange: if use `div` on all three statistics, then the output does not have avg * count == sum anymore; if only on sum and avg, it might be misleading.
suyuee
force-pushed
the
print_stats_map_args_check
branch
from
98f80d4 to
662f93f
Compare
|
Updated CHANGELOG.md |
danobi
approved these changes
Jul 23, 2020
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.
Both
topanddivare ambiguous when printing stats maps.topdoes notspecify which statistic it's based on and it would cause confusion to define a
default behavior for it. As for
div, it would also somehow be strange: if usedivon all three statistics, then the output does not have avg * count == sumanymore; if only on sum and avg, it might be misleading.
Related to #1416.
Checklist
docs/reference_guide.mdCHANGELOG.md