Skip to content

bpo-43896: Update the Sphinx directive for super from function to class #25489

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 1 commit into from
Apr 20, 2021
Merged

bpo-43896: Update the Sphinx directive for super from function to class #25489

merged 1 commit into from
Apr 20, 2021
+1 −1

Conversation

geryogam
Copy link
Contributor

@geryogam geryogam commented Apr 20, 2021 •
edited
Loading

This PR updates the page Built-in Functions of the Python library documentation: super is not a function (isinstance(super, type(lambda: None)) is False), it is a type (isinstance(super, type) is True), like int, tuple, set, etc. So it should get the same “class” prefix, i.e.

super([type[, object-or-type]])

should become

class super([type[, object-or-type]])

https://bugs.python.org/issue43896

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 20, 2021
@geryogam geryogam changed the title Update Sphinx directive for super from function to class Update the Sphinx directive for super from function to class Apr 20, 2021
@geryogam geryogam changed the title Update the Sphinx directive for super from function to class bpo-43896: Update the Sphinx directive for super from function to class Apr 20, 2021
@rhettinger rhettinger closed this Apr 20, 2021
@rhettinger rhettinger reopened this Apr 20, 2021
@rhettinger rhettinger merged commit d35eef3 into python:master Apr 20, 2021
@geryogam geryogam deleted the patch-25 branch April 20, 2021 20:49
@geryogam
Copy link
Contributor Author

Thank you for reviewing this @rhettinger.

@geryogam
Copy link
Contributor Author

@rhettinger, should this change be backported to maintenance branches?

@rhettinger
Copy link
Contributor

No, it is almost completely inconsequential.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@geryogam @rhettinger @the-knights-who-say-ni @bedevere-bot