Skip to content

Document func parameter of locale.atof #18183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Apr 2, 2022
Merged

Document func parameter of locale.atof #18183

merged 2 commits into from
Apr 2, 2022

Conversation

kevinoid
Copy link
Contributor

A second parameter (named func) was added to locale.atof in b64bca9, first released in v3.5.0, but was not documented.

This PR updates the documentation for locale.atof to clarify thebehavior of the function and how the func parameter is used.

Thanks for considering,
Kevin

@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@kevinoid

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jan 25, 2020
csabella
csabella reviewed May 28, 2020
View reviewed changes
@csabella csabella requested a review from pitrou May 28, 2020 01:20
@kevinoid
Document func parameter of locale.atof
b61a38e 
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>
@kevinoid kevinoid force-pushed the doc-locale-atof-func branch from ff32332 to b61a38e Compare May 28, 2020 02:13
@JelleZijlstra JelleZijlstra self-assigned this Mar 28, 2022
@JelleZijlstra JelleZijlstra merged commit 208da6d into python:main Apr 2, 2022
@miss-islington
Copy link
Contributor

Thanks @kevinoid for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry @kevinoid and @JelleZijlstra, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 208da6d508bb2683732151f4ae288dfc8001267c 3.10

@miss-islington
Copy link
Contributor

Sorry, @kevinoid and @JelleZijlstra, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 208da6d508bb2683732151f4ae288dfc8001267c 3.9

@JelleZijlstra JelleZijlstra added needs backport to 3.10 only security fixes and removed needs backport to 3.10 only security fixes labels Apr 2, 2022
@miss-islington
Copy link
Contributor

Thanks @kevinoid for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry @kevinoid and @JelleZijlstra, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 208da6d508bb2683732151f4ae288dfc8001267c 3.10

JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this pull request Apr 2, 2022
@kevinoid @JelleZijlstra
[3.9] Document func parameter of locale.atof (pythonGH-18183)
6bef480 
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>.
(cherry picked from commit 208da6d)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Apr 2, 2022
@bedevere-bot
Copy link

GH-32261 is a backport of this pull request to the 3.9 branch.

JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this pull request Apr 2, 2022
@kevinoid @JelleZijlstra
[3.10] Document func parameter of locale.atof (pythonGH-18183)
700c69b 
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>
(cherry picked from commit 208da6d)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Apr 2, 2022
@bedevere-bot
Copy link

GH-32262 is a backport of this pull request to the 3.10 branch.

JelleZijlstra added a commit that referenced this pull request Apr 2, 2022
@JelleZijlstra @kevinoid
[3.10] Document func parameter of locale.atof (GH-18183) (GH-32262)
a930062 
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>
(cherry picked from commit 208da6d)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
JelleZijlstra added a commit that referenced this pull request Apr 2, 2022
@JelleZijlstra @kevinoid
[3.9] Document func parameter of locale.atof (GH-18183) (GH-32261)
62da258 
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>.
(cherry picked from commit 208da6d)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@JelleZijlstra @kevinoid @hello-adam
[3.9] Document func parameter of locale.atof (pythonGH-18183) (python…
fcc7d40 
…GH-32261)

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>.
(cherry picked from commit 208da6d)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@csabella csabella csabella left review comments

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@pitrou pitrou Awaiting requested review from pitrou

Assignees

@JelleZijlstra JelleZijlstra

Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@kevinoid @the-knights-who-say-ni @miss-islington @bedevere-bot @JelleZijlstra @csabella