Repository navigation
Docs: clarify metric prefix selection examples - #469
Merged
hugovk merged 1 commit intoNov 12, 2026
Merged
Conversation
hugovk
enabled auto-merge (squash)
November 12, 2026 11:47
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #469 +/- ##
=======================================
Coverage 99.69% 99.69%
=======================================
Files 12 12
Lines 995 995
=======================================
Hits 992 992
Misses 3 3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
Changes proposed in this pull request:
metric()explanation, which currently says non-significant zeroes are required when describing how prefixes avoid them.kfor kilo and turn the two prefix-selection examples into executable doctests showing the actual output, including spacing.This only changes the docstring; runtime behavior is unchanged.
Behavior and review notes
The examples document prefix selection and exact rendered text, including the lowercase SI kilo symbol and the space before the prefix. Making those outputs doctests keeps the prose tied to the current implementation. No numerical rounding, prefix thresholds, or formatting defaults are modified.
Validation on Linux, Python 3.13.5:
metric()examples.mkdocs build --strict: passed; checked the generated number API page.mypy .: passed for all 14 source files.Prepared and validated with Codex assistance. The full runtime test suite and other platforms were not run for this documentation-only change.