GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [3.11] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-106904) by miss-islington · Pull Request #106946 · python/cpython

Conversation

@miss-islington

@miss-islington miss-islington commented Jul 21, 2023 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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 [email protected]
Co-authored-by: Ezio Melotti [email protected]


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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@erlend-aasland @ezio-melotti @miss-islington
Docs: Argument Clinic: Add Background and Tutorial top-level sections (…
6d87c44
…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 <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
@bedevere-bot bedevere-bot mentioned this pull request Jul 21, 2023
Docs: Argument Clinic: Add Background and Tutorial top-level sections #106904
Merged
@bedevere-bot bedevere-bot added skip issue skip news awaiting review docs Documentation in the Doc dir labels Jul 21, 2023
erlend-aasland
erlend-aasland approved these changes Jul 21, 2023
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels Jul 21, 2023
@erlend-aasland
erlend-aasland merged commit 0a57620 into python:3.11 Jul 21, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label Jul 21, 2023
@miss-islington
miss-islington deleted the backport-81861fd-3.11 branch July 21, 2023 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erlend-aasland erlend-aasland erlend-aasland approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@miss-islington @erlend-aasland @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.