about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorNaïm Favier <n@monade.li>2022-09-09 15:39:35 +0200
committerNaïm Favier <n@monade.li>2022-09-09 15:39:35 +0200
commit52bbbaeb09859b02561a1895f0516e094b2f9d67 (patch)
tree44f55fe7431fc054505aead23d6079a453e3b109 /nixos
parent5480f45f63f75d9340d5d48602f47d04d3625a2f (diff)
downloadnixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.tar
nixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.tar.gz
nixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.tar.bz2
nixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.tar.lz
nixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.tar.xz
nixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.tar.zst
nixlib-52bbbaeb09859b02561a1895f0516e094b2f9d67.zip
nixos/doc/option-types: add precision loss warning for floats
Diffstat (limited to 'nixos')
-rw-r--r--nixos/doc/manual/development/option-types.section.md5
-rw-r--r--nixos/doc/manual/from_md/development/option-types.section.xml9
2 files changed, 14 insertions, 0 deletions
diff --git a/nixos/doc/manual/development/option-types.section.md b/nixos/doc/manual/development/option-types.section.md
index 7864b62605c2..40b4d78b250e 100644
--- a/nixos/doc/manual/development/option-types.section.md
+++ b/nixos/doc/manual/development/option-types.section.md
@@ -140,6 +140,11 @@ merging is handled.
 
 :   A floating point number.
 
+    ::: {.warning}
+    Converting a floating point number to a string with `toString` or `toJSON`
+    may result in [precision loss](https://github.com/NixOS/nix/issues/5733).
+    :::
+
 `types.number`
 
 :   Either a signed integer or a floating point number. No implicit conversion
diff --git a/nixos/doc/manual/from_md/development/option-types.section.xml b/nixos/doc/manual/from_md/development/option-types.section.xml
index e207b97a46f8..4036bc0ba743 100644
--- a/nixos/doc/manual/from_md/development/option-types.section.xml
+++ b/nixos/doc/manual/from_md/development/option-types.section.xml
@@ -256,6 +256,15 @@
             <para>
               A floating point number.
             </para>
+            <warning>
+              <para>
+                Converting a floating point number to a string with
+                <literal>toString</literal> or <literal>toJSON</literal>
+                may result in
+                <link xlink:href="https://github.com/NixOS/nix/issues/5733">precision
+                loss</link>.
+              </para>
+            </warning>
           </listitem>
         </varlistentry>
         <varlistentry>