gh-99521: add notation key explaining in built-in functions #142641
Closed
+9
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
All commit authors signed the Contributor License Agreement. |
picnixz
reviewed
Dec 12, 2025
Comment on lines
+7
to
+12
| 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. | ||
|
|
Member
There was a problem hiding this comment.
Please wrap the text under 80 characters.
picnixz
reviewed
Dec 12, 2025
Comment on lines
+4
to
+5
| Notation | ||
| -------- |
Member
There was a problem hiding this comment.
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.
Member
|
Actually, there wasn't a consensus on the issue on what to do (no core dev expressed their opinions as of now) so I'm closing this for now. Sorry but please do not create PR if there isn't a consensus or a maintainer's decision. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📚 Documentation preview 📚: https://cpython-previews--142641.org.readthedocs.build/