summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad Martin <brad.martin@ibotta.com>2020-05-10 12:02:16 -0600
committerGitHub <noreply@github.com>2020-05-10 21:02:16 +0300
commite7e4265d9a037ac38bba99f8513fb9e48a1081ba (patch)
tree86b0bf73f04d724409a6407cc226ff79f5903727
parent2a826bb1ad9996a1c1e2d3e86a493d01d7f12c09 (diff)
downloadbabel-e7e4265d9a037ac38bba99f8513fb9e48a1081ba.tar.gz
docs/numbers.rst : update parse_number comments (#708)
* docs/numbers.rst : test format of revised comments * docs/numbers.rst : test final doc changes * docs/numbers.rst : refine format/language * docs/numbers.rst : refine language/format * docs/numbers.rst : refine language/format * docs/numbers.rst : experiment with spacing
-rw-r--r--docs/numbers.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/numbers.rst b/docs/numbers.rst
index df834ea..058d79e 100644
--- a/docs/numbers.rst
+++ b/docs/numbers.rst
@@ -160,4 +160,21 @@ Examples:
...
NumberFormatError: '2,109,998' is not a valid decimal number
-.. note:: Number parsing is not properly implemented yet
+Note: as of version 2.8.0, the ``parse_number`` function has limited
+functionality. It can remove group symbols of certain locales from numeric
+strings, but may behave unexpectedly until its logic handles more encoding
+issues and other special cases.
+
+Examples:
+
+.. code-block:: pycon
+
+ >>> parse_number('1,099', locale='en_US')
+ 1099
+ >>> parse_number('1.099.024', locale='de')
+ 1099024
+ >>> parse_number('123' + u'\xa0' + '4567', locale='ru')
+ 1234567
+ >>> parse_number('123 4567', locale='ru')
+ ...
+ NumberFormatError: '123 4567' is not a valid number