From e7e4265d9a037ac38bba99f8513fb9e48a1081ba Mon Sep 17 00:00:00 2001 From: Brad Martin Date: Sun, 10 May 2020 12:02:16 -0600 Subject: 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 --- docs/numbers.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'docs') 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 -- cgit v1.2.1