Clarify wording of human_to_bytes filter #82074
Open
+5
−1
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
ansibot
added
the
needs_triage
bcoca
reviewed
Oct 25, 2023
| @@ -4,10 +4,11 @@ DOCUMENTATION: | |||
| short_description: Get bytes from string | |||
| description: | |||
| - Convert a human-readable byte or bit string into a number bytes. | |||
| - Will always use base 2 (1024) for the unit prefix, e.g 1 KB is 1024, 1MB is 1048576, etc. | |||
There was a problem hiding this comment.
this is incorrect, see when "b" is added or isbits option is used. At best you should say ' it defaults to the isbits value if no identifier is present'
There was a problem hiding this comment.
It might be a bug, but 12b will parse to 12 when isbits=false. Any unit prefixes, e.g. 12kb will then throw an error: 'human_to_bytes() can''t interpret following string: 12kb'.
With isbits=true, 12kb will still evaluate to 13312, so it's still correctly uses 1024. No conversion between bytes and bits happens in that code.
So I guess the line above the one added is incorrect, though, as it doesn't convert a bit string to a number bytes.
jborean93
removed
the
needs_triage
ansibot
added
the
stale_ci
ansibot
added
needs_rebase
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.
SUMMARY
Minor Improvement of wording to clarify that it always uses multiple of 1024 (and not 1000).
ISSUE TYPE