Skip to content

Commit 4ab3e14

Browse files
committed
gh-99521: add notation key explaining in built-in functions
1 parent a716091 commit 4ab3e14

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Doc/library/functions.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
.. XXX document all delegations to __special__ methods
22
.. _built-in-funcs:
33

4+
Notation
5+
--------
6+
7+
In the function signatures that follow you may see some special markers:
8+
9+
- ``/`` (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.
10+
11+
- ``*`` (a single asterisk) — indicates that the parameters following it are *keyword-only* and must be supplied using their parameter names.
12+
413
Built-in Functions
514
==================
615

0 commit comments

Comments
 (0)