mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 11:44:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.10] Document func parameter of locale.atof (GH-18183) (GH-32262)

Browse source 
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>
(cherry picked from commit 208da6d508)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
This commit is contained in:
Jelle Zijlstra 2022-04-02 15:59:41 -07:00 • committed by GitHub
parent 3031b86753
commit a930062d25
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/locale.rst
View file

@ -435,10 +435,10 @@ The :mod:`locale` module defines the following exception and functions:
.. versionadded:: 3.10
.. 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)