Skip to content

gh-99521: add notation key explaining in built-in functions #142641

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

Closed
mcaramba563 wants to merge 1 commit into from
+9 −0
Closed

gh-99521: add notation key explaining in built-in functions #142641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
.. XXX document all delegations to __special__ methods
.. _built-in-funcs:

Notation
--------
Comment on lines +4 to +5
Copy link
Member

@picnixz picnixz Dec 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Please make sure that the Notation title is not a subtitle compared to "Built-in" functions otherwise it becomes weird. I wonder whether we should put this in functions.rst or intro.rst as well. In addition there were multiple options proposed in the issue and no consensus was reached.


In the function signatures that follow you may see some special markers:

- ``/`` (a single forward slash) — indicates that the parameters before it are *positional-only*. Parameters to the left of ``/`` must be supplied positionally and cannot be passed as keyword arguments. For example, ``repr(object, /)`` means ``object`` is positional-only.

- ``*`` (a single asterisk) — indicates that the parameters following it are *keyword-only* and must be supplied using their parameter names.

Comment on lines +7 to +12
Copy link
Member

@picnixz picnixz Dec 12, 2025

Choose a reason for hiding this comment

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

Please wrap the text under 80 characters.

Built-in Functions
==================

Expand Down
Loading