8000 [3.12] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-106904) by miss-islington · Pull Request #106945 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

[3.12] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-106904) #106945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2023

Conversation

miss-islington
Copy link
Contributor
@miss-islington miss-islington commented Jul 21, 2023

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 81861fd)

Co-authored-by: Erlend E. Aasland erlend@python.org
Co-authored-by: Ezio Melotti ezio.melotti@gmail.com


📚 Documentation preview 📚: https://cpython-previews--106945.org.readthedocs.build/

…pythonGH-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 81861fd)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@erlend-aasland erlend-aasland merged commit 1a3766b into python:3.12 Jul 21, 2023
@miss-islington miss-islington deleted the backport-81861fd-3.12 branch July 21, 2023 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0