Clarify wording of human_to_bytes filter

pull/82074/head
Lee Garrett 1 year ago committed by GitHub
parent bf29458726
commit b87c5c7b13
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -4,10 +4,11 @@ DOCUMENTATION:
short_description: Get bytes from string short_description: Get bytes from string
description: description:
- Convert a human-readable byte or bit string into a number bytes. - 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.
positional: _input, default_unit, isbits positional: _input, default_unit, isbits
options: options:
_input: _input:
description: human-readable description of a number of bytes. description: human-readable description of a number of bytes. "B" may be omitted from the unit.
type: int type: int
required: true required: true
default_unit: default_unit:
@ -18,6 +19,9 @@ DOCUMENTATION:
description: If V(True), force to interpret only bit input; if V(False), force bytes. Otherwise use the notation to guess. description: If V(True), force to interpret only bit input; if V(False), force bytes. Otherwise use the notation to guess.
type: bool type: bool
EXAMPLES: | EXAMPLES: |
# size => 1024
size: '{{ "1 K" | human_to_bytes }}'
size: '{{ "1 KB" | human_to_bytes }}'
# size => 1234803098 # size => 1234803098
size: '{{ "1.15 GB" | human_to_bytes }}' size: '{{ "1.15 GB" | human_to_bytes }}'

Loading…
Cancel
Save