Skip to content

Explained how to improve the readability of long numeric literals #7196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Explained how to improve the readability of long numeric literals #7196

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aea328d
Explained how to improve the readability of long numeric literals
javiereguiluz Nov 29, 2016
b44cce8
Fixed a typo
javiereguiluz Dec 8, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions components/yaml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,25 @@ changed using the third argument as follows::
foo: bar
bar: baz

Numeric Literals
................

Long numeric literals, being integer, float or hexadecimal, are known for their
poor readability in code and configuration files. That's why YAML files allow to
add underscores to improve their readability:

.. code-block:: yaml

parameters:
credit_card_number: 1234_5678_9012_3456
long_number: 10_000_000_000
pi: 3.14159_26535_89793
hex_words: 0x_CAFE_F00D

During the parsing of the YAML contents, all the ``_`` characters are removed
from the numeric literal contents, so there is not a limit in the number of
underscores you can include or the way you group contents.

Advanced Usage: Flags
---------------------

Expand Down