feature #7196 Explained how to improve the readability of long numeric literals (javiereguiluz)

xabbuh · xabbuh · commit 03d7e4fe4015 · 2016-12-14T19:24:46.000+01:00
This PR was squashed before being merged into the 3.2 branch (closes #7196). Discussion ---------- Explained how to improve the readability of long numeric literals This fixes #7183. Commits ------- 494a9ae Explained how to improve the readability of long numeric literals
diff --git a/components/yaml.rst b/components/yaml.rst
@@ -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
 ---------------------
 
