Skip to content

Commit e7e4265

Browse files
author
Brad Martin
authored
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
1 parent 2a826bb commit e7e4265

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

docs/numbers.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,21 @@ Examples:
160160
...
161161
NumberFormatError: '2,109,998' is not a valid decimal number
162162
163-
.. note:: Number parsing is not properly implemented yet
163+
Note: as of version 2.8.0, the ``parse_number`` function has limited
164+
functionality. It can remove group symbols of certain locales from numeric
165+
strings, but may behave unexpectedly until its logic handles more encoding
166+
issues and other special cases.
167+
168+
Examples:
169+
170+
.. code-block:: pycon
171+
172+
>>> parse_number('1,099', locale='en_US')
173+
1099
174+
>>> parse_number('1.099.024', locale='de')
175+
1099024
176+
>>> parse_number('123' + u'\xa0' + '4567', locale='ru')
177+
1234567
178+
>>> parse_number('123 4567', locale='ru')
179+
...
180+
NumberFormatError: '123 4567' is not a valid number

0 commit comments

Comments
 (0)