]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.12] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 21 Jul 2023 06:18:18 +0000 (23:18 -0700)
committerGitHub <noreply@github.com>
Fri, 21 Jul 2023 06:18:18 +0000 (08:18 +0200)
commit1a3766bb3e5ad5cdd7c3e4c352eb0147ccc9a6ce
treeda8aa9781d07648614e1e5fc9496e3c1d709d6ab
parent656f62454bff35db8d630ca43c94bf6db44338ba
[3.12] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-106904) (#106945)

Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-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.
(cherry picked from commit 81861fd90b4ae981e7881cd03a3c370713063525)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Doc/howto/clinic.rst