traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document func parameter of locale.atof 

The second parameter (named `func`) has been present since the `locale`
module was introduced in eef1d4e8b1, but has never been documented.

This commit updates the documentation for `locale.atof` to clarify the
behavior of the function and how the `func` parameter is used.

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
This commit is contained in:
Kevin Locke 2020-01-25 08:45:27 -07:00
parent 9bfb4a7061
commit b61a38e81f
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/library/locale.rst
View File

@ -423,10 +423,10 @@ The :mod:`locale` module defines the following exception and functions:
.. versionadded:: 3.5
.. function:: atof(string)
.. function:: atof(string, func=float)
Converts a string to a floating point number, following the :const:`LC_NUMERIC`
settings.
Converts a string to a number, following the :const:`LC_NUMERIC` settings,
by calling *func* on the result of calling :func:`delocalize` on *string*.
.. function:: atoi(string)