]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
Docs: Argument Clinic: Add Background and Tutorial top-level sections (#106904)
authorErlend E. Aasland <erlend@python.org>
Fri, 21 Jul 2023 06:05:41 +0000 (08:05 +0200)
committerGitHub <noreply@github.com>
Fri, 21 Jul 2023 06:05:41 +0000 (08:05 +0200)
commit81861fd90b4ae981e7881cd03a3c370713063525
treef9f63021b180caca7b2ec3d441a29bdd70dbb146
parent8d228cf66f316803e95685d6553084f3d60cd9c5
Docs: Argument Clinic: Add Background and Tutorial top-level sections (#106904)

Add Background as a toplevel section with the following subsections:

- Background
  - The goals of Argument Clinic
  - Basic concepts and usage

Rename "Converting your first function" to Tutorial.

Add anchors for Background, Tutorial, and How-to Guides:

- :ref:`clinic-background`
- :ref:`clinic-tutorial`
- :ref:`clinic-howtos`

Link to these from within the Abstract.

Break the compatibility paragraph out of Abstract and make it a note.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Doc/howto/clinic.rst