diff options
| author | Kevin Locke <kevin@kevinlocke.name> | 2022-04-02 19:52:05 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-02 19:52:05 (GMT) |
| commit | 208da6d508bb2683732151f4ae288dfc8001267c (patch) | |
| tree | 29bbfdb47609a17a342c31d9d36b7548afc97e26 /Doc/library/locale.rst | |
| parent | 677a87946630c5fbd9998969669b4dd4f4b32545 (diff) | |
| download | cpython-208da6d508bb2683732151f4ae288dfc8001267c.zip cpython-208da6d508bb2683732151f4ae288dfc8001267c.tar.gz cpython-208da6d508bb2683732151f4ae288dfc8001267c.tar.bz2 | |
Document func parameter of locale.atof (GH-18183)
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>
Diffstat (limited to 'Doc/library/locale.rst')
| -rw-r--r-- | Doc/library/locale.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index 1b14734..01e14a1 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -437,10 +437,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) |