mirror of https://github.com/python/cpython
GH-107518: Remove the Argument Clinic How-To (#109900)
* Remove the content of the Argument Clinic HOWTO * Update cross-references to the Argument Clinic * Add a note directing readers to the devguide
This commit is contained in:
parent
f83fa0b9eb
commit
d1f7fae424
2066
Doc/howto/clinic.rst
2066
Doc/howto/clinic.rst
File diff suppressed because it is too large
Load Diff
|
@ -28,7 +28,6 @@ Currently, the HOWTOs are:
|
||||||
urllib2.rst
|
urllib2.rst
|
||||||
argparse.rst
|
argparse.rst
|
||||||
ipaddress.rst
|
ipaddress.rst
|
||||||
clinic.rst
|
|
||||||
instrumentation.rst
|
instrumentation.rst
|
||||||
perf_profiling.rst
|
perf_profiling.rst
|
||||||
annotations.rst
|
annotations.rst
|
||||||
|
|
|
@ -123,7 +123,7 @@ There is a new function parameter syntax ``/`` to indicate that some
|
||||||
function parameters must be specified positionally and cannot be used as
|
function parameters must be specified positionally and cannot be used as
|
||||||
keyword arguments. This is the same notation shown by ``help()`` for C
|
keyword arguments. This is the same notation shown by ``help()`` for C
|
||||||
functions annotated with Larry Hastings'
|
functions annotated with Larry Hastings'
|
||||||
:ref:`Argument Clinic <howto-clinic>` tool.
|
`Argument Clinic <devguide.python.org/development-tools/clinic/>`__ tool.
|
||||||
|
|
||||||
In the following example, parameters *a* and *b* are positional-only,
|
In the following example, parameters *a* and *b* are positional-only,
|
||||||
while *c* or *d* can be positional or keyword, and *e* or *f* are
|
while *c* or *d* can be positional or keyword, and *e* or *f* are
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
It is now possible to deprecate passing parameters positionally with
|
It is now possible to deprecate passing parameters positionally with
|
||||||
Argument Clinic, using the new ``* [from X.Y]`` syntax.
|
Argument Clinic, using the new ``* [from X.Y]`` syntax.
|
||||||
(To be read as *"keyword-only from Python version X.Y"*.)
|
(To be read as *"keyword-only from Python version X.Y"*.)
|
||||||
See :ref:`clinic-howto-deprecate-positional` for more information.
|
See `documentation in the Python Developer's Guide
|
||||||
|
<https://devguide.python.org/development-tools/clinic/#clinic-howto-deprecate-positional>`__
|
||||||
|
for more information.
|
||||||
Patch by Erlend E. Aasland with help from Alex Waygood,
|
Patch by Erlend E. Aasland with help from Alex Waygood,
|
||||||
Nikita Sobolev, and Serhiy Storchaka.
|
Nikita Sobolev, and Serhiy Storchaka.
|
||||||
|
|
|
@ -1,2 +1,3 @@
|
||||||
Argument Clinic now supports overriding automatically generated signature by
|
Argument Clinic now supports overriding automatically generated signature by
|
||||||
using directive ``@text_signature``. See :ref:`clinic-howto-override-signature`.
|
using directive ``@text_signature``. See `documentation in the Python Developer's Guide
|
||||||
|
<https://devguide.python.org/development-tools/clinic/#clinic-howto-override-signature>`__
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
It is now possible to deprecate passing keyword arguments for
|
It is now possible to deprecate passing keyword arguments for
|
||||||
keyword-or-positional parameters with Argument Clinic, using the new ``/
|
keyword-or-positional parameters with Argument Clinic, using the new ``/
|
||||||
[from X.Y]`` syntax. (To be read as *"positional-only from Python version
|
[from X.Y]`` syntax. (To be read as *"positional-only from Python version
|
||||||
X.Y"*.) See :ref:`clinic-howto-deprecate-keyword` for more information.
|
X.Y"*.) See `documentation in the Python Developer's Guide
|
||||||
|
<https://devguide.python.org/development-tools/clinic/#clinic-howto-deprecate-keyword>`__
|
||||||
|
for more information.
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
:ref:`Argument Clinic <howto-clinic>` now has a partial support of the
|
`Argument Clinic <https://devguide.python.org/development-tools/clinic/>`__
|
||||||
:ref:`Limited API <limited-c-api>`: see :ref:`clinic-howto-limited-capi`.
|
now has a partial support of the :ref:`Limited API <limited-c-api>`: see
|
||||||
|
`documentation in the Python Developer's Guide
|
||||||
|
<https://devguide.python.org/development-tools/clinic/#clinic-howto-limited-capi>`__
|
||||||
Patch by Victor Stinner.
|
Patch by Victor Stinner.
|
||||||
|
|
Loading…
Reference in New Issue