Skip to content

Commit b61a38e

Browse files
committed
Document func parameter of locale.atof
The second parameter (named `func`) has been present since the `locale` module was introduced in eef1d4e, 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>
1 parent 9bfb4a7 commit b61a38e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Doc/library/locale.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -423,10 +423,10 @@ The :mod:`locale` module defines the following exception and functions:
423423
.. versionadded:: 3.5
424424

425425

426-
.. function:: atof(string)
426+
.. function:: atof(string, func=float)
427427

428-
Converts a string to a floating point number, following the :const:`LC_NUMERIC`
429-
settings.
428+
Converts a string to a number, following the :const:`LC_NUMERIC` settings,
429+
by calling *func* on the result of calling :func:`delocalize` on *string*.
430430

431431

432432
.. function:: atoi(string)

0 commit comments

Comments
 (0)