From b61a38e81f132e01b19ee1c5086f678e0172234e Mon Sep 17 00:00:00 2001 From: Kevin Locke Date: Sat, 25 Jan 2020 08:45:27 -0700 Subject: [PATCH] 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 --- Doc/library/locale.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index bf57a083559168..5b5a0c7552323d 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -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)