Skip to content

bpo-42840: Document providing kwargs to type. #24173

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 4 commits into from
Mar 1, 2021
Merged

bpo-42840: Document providing kwargs to type. #24173

merged 4 commits into from
Mar 1, 2021

Conversation

esoma
Copy link
Contributor

@esoma esoma commented Jan 8, 2021 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jan 8, 2021
Fidget-Spinner
Fidget-Spinner reviewed Jan 9, 2021
View reviewed changes
Copy link
Member

@Fidget-Spinner Fidget-Spinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making this PR to improve the docs! I have some minor comments.

Doc/library/functions.rst
@@ -1690,7 +1690,7 @@ are always available. They are listed here in alphabetical order.


.. class:: type(object)
type(name, bases, dict)
type(name, bases, dict, **kwds)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I like kwds more, but the rest of the document seems to be using **kwargs or **kwarg (there's one **kws too !), so I'd suggest using **kwargs to keep consistent.

Suggested change
type(name, bases, dict, **kwds)
type(name, bases, dict, **kwargs)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my initial choice, but typeshed and the section on customizing class creation in the docs mostly uses **kwds (it also uses **kwargs once). Given that reasoning, if you still think **kwargs is best I'm happy to change it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Up to you. I think as it stands right now it's okay :).

@esoma @Fidget-Spinner
Reference kwargs relation to __init_subclass__
fa90d58 
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Fidget-Spinner
Fidget-Spinner approved these changes Jan 9, 2021
View reviewed changes
Copy link
Member

@Fidget-Spinner Fidget-Spinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@github-actions
Copy link

github-actions bot commented Feb 9, 2021

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Feb 9, 2021
gvanrossum
gvanrossum approved these changes Mar 1, 2021
View reviewed changes
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll merge this now. I'll mark it for backport to 3.9 and 3.8, but if those backports fail I'll just give up on them.

@gvanrossum gvanrossum merged commit 72fcd14 into python:master Mar 1, 2021
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

@gvanrossum: Please replace # with GH- in the commit message next time. Thanks!

@bedevere-bot
Copy link

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

@bedevere-bot
Copy link

GH-24696 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 1, 2021
@esoma @miss-islington
bpo-42840: Document providing kwargs to type. (pythonGH-24173)
172df82 
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 72fcd14)

Co-authored-by: Erik Soma <stillusingirc@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 1, 2021
@esoma @miss-islington
bpo-42840: Document providing kwargs to type. (pythonGH-24173)
6683693 
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 72fcd14)

Co-authored-by: Erik Soma <stillusingirc@gmail.com>
miss-islington added a commit that referenced this pull request Mar 1, 2021
@miss-islington @esoma
bpo-42840: Document providing kwargs to type. (GH-24173)
7101d15 
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 72fcd14)

Co-authored-by: Erik Soma <stillusingirc@gmail.com>
miss-islington added a commit that referenced this pull request Apr 1, 2021
@miss-islington @esoma
bpo-42840: Document providing kwargs to type. (GH-24173)
b3c1e2c 
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 72fcd14)

Co-authored-by: Erik Soma <stillusingirc@gmail.com>
@esoma esoma mannequin mentioned this pull request May 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gvanrossum gvanrossum gvanrossum approved these changes

@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@esoma @miss-islington @bedevere-bot @gvanrossum @Fidget-Spinner @the-knights-who-say-ni