From 1975a4d7ab7bd60f607b6c9e58d6a227db3c14ff Mon Sep 17 00:00:00 2001
From: Christian Schreinemachers <42220742+Cs137@users.noreply.github.com>
Date: Fri, 24 Jan 2025 13:32:55 +0100
Subject: [PATCH] Fix typos in `ufloat_fromstr` doctring examples (#286)

---
 CHANGES.rst           |  2 ++
 uncertainties/core.py | 18 ++++++++++++------
 2 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/CHANGES.rst b/CHANGES.rst
index df962506..f273fddf 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -24,6 +24,8 @@ Adds:
 
 Fixes:
 
+- add note on string not containing uncertainty to `ufloat_fromstr` doctring (#287)
+- fix typos in `ufloat_fromstr` docstring examples (#285)
 - fix `readthedocs` configuration so that the build passes (#254)
 - adjust `codecov.io` configuration so that minor code coverage changes will not result
    in indications that tests are failing. Rather code coverage reports will be purely
diff --git a/uncertainties/core.py b/uncertainties/core.py
index c521a87f..cf66809a 100644
--- a/uncertainties/core.py
+++ b/uncertainties/core.py
@@ -985,19 +985,25 @@ def ufloat_fromstr(representation, tag=None):
        That is, "1.25(3)" is the same as `ufloat(1.25, 0.03)`,
        while "1.25(3.)" is the same as `ufloat(1.25, 3.)`
 
+    3. If the representation does not contain an uncertainty, an
+       uncertainty of 1 in the least significant digit is assigned to
+       the nominal value. For nominal values corresponding to "nan", an
+       uncertainty of 1 is assigned.
+
     Examples:
     -----------
 
-    >>> x = ufloat_fromsstr("12.58+/-0.23")  # = ufloat(12.58, 0.23)
-    >>> x = ufloat_fromsstr("12.58 ± 0.23")  # = ufloat(12.58, 0.23)
-    >>> x = ufloat_fromsstr("3.85e5 +/- 2.3e4")  # = ufloat(3.8e5, 2.3e4)
-    >>> x = ufloat_fromsstr("(38.5 +/- 2.3)e4")  # = ufloat(3.8e5, 2.3e4)
+    >>> x = ufloat_fromstr("12.58+/-0.23")  # = ufloat(12.58, 0.23)
+    >>> x = ufloat_fromstr("12.58 ± 0.23")  # = ufloat(12.58, 0.23)
+    >>> x = ufloat_fromstr("3.85e5 +/- 2.3e4")  # = ufloat(3.8e5, 2.3e4)
+    >>> x = ufloat_fromstr("(38.5 +/- 2.3)e4")  # = ufloat(3.8e5, 2.3e4)
 
-    >>> x = ufloat_fromsstr("72.1(2.2)")  # = ufloat(72.1, 2.2)
-    >>> x = ufloat_fromsstr("72.15(4)")  # = ufloat(72.15, 0.04)
+    >>> x = ufloat_fromstr("72.1(2.2)")  # = ufloat(72.1, 2.2)
+    >>> x = ufloat_fromstr("72.15(4)")  # = ufloat(72.15, 0.04)
     >>> x = ufloat_fromstr("680(41)e-3")  # = ufloat(0.68, 0.041)
     >>> x = ufloat_fromstr("23.2")  # = ufloat(23.2, 0.1)
     >>> x = ufloat_fromstr("23.29")  # = ufloat(23.29, 0.01)
+    >>> x = ufloat_fromstr("nan")  # = ufloat(numpy.nan, 1.0)
 
     >>> x = ufloat_fromstr("680.3(nan)") # = ufloat(680.3, numpy.nan)
     """