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 — Docs: Argument Clinic: Add Background and Tutorial top-level sections by erlend-aasland · Pull Request #106904 · python/cpython

Conversation

@erlend-aasland

@erlend-aasland erlend-aasland commented Jul 19, 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 -- converting your first function"

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.


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

Sorry, something went wrong.

Uh oh!

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

All reactions
@erlend-aasland
Docs: Add Background and Tutorial top-level sections
62723cf
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 -- converting your first function"

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.
@erlend-aasland erlend-aasland added skip issue skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 19, 2023
@erlend-aasland
erlend-aasland requested a review from ezio-melotti July 19, 2023 22:46
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 19, 2023
erlend-aasland added 2 commits July 20, 2023 00:47
@erlend-aasland
Style
532dd98
@erlend-aasland
Remove spurious change
de44907
@erlend-aasland erlend-aasland changed the title Docs: Add Background and Tutorial top-level sections Docs: Argument Clinic: Add Background and Tutorial top-level sections Jul 19, 2023
ezio-melotti
ezio-melotti reviewed Jul 19, 2023
View reviewed changes
Comment thread Doc/howto/clinic.rst Resolved

Uh oh!

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

@erlend-aasland @ezio-melotti
Address review: need three dashes for em-dash
c900340
Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
ezio-melotti reviewed Jul 19, 2023
View reviewed changes
Comment thread Doc/howto/clinic.rst Resolved

Uh oh!

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

erlend-aasland added 2 commits July 20, 2023 19:44
@erlend-aasland
Pull in main
173e7fa
@erlend-aasland
Address review
c1bf977
@erlend-aasland
erlend-aasland requested a review from ezio-melotti July 20, 2023 17:45
@erlend-aasland erlend-aasland mentioned this pull request Jul 20, 2023
gh-106799: Pick another example method for Argument Clinic How-To #106800
Closed
ezio-melotti
ezio-melotti approved these changes Jul 21, 2023
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Jul 21, 2023
@erlend-aasland
erlend-aasland merged commit 81861fd into python:main Jul 21, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label Jul 21, 2023
@miss-islington

miss-islington commented Jul 21, 2023

Copy link
Copy Markdown
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot

bedevere-bot commented Jul 21, 2023

Copy link
Copy Markdown

GH-106945 is a backport of this pull request to the 3.12 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@erlend-aasland
erlend-aasland deleted the clinic-docs/restructuring branch July 21, 2023 06:05
@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 21, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 21, 2023
@erlend-aasland @ezio-melotti @miss-islington
Docs: Argument Clinic: Add Background and Tutorial top-level sections (…
79a05ee
…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 commented Jul 21, 2023

Copy link
Copy Markdown

GH-106946 is a backport of this pull request to the 3.11 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 21, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 21, 2023
@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]>
erlend-aasland added a commit that referenced this pull request Jul 21, 2023
@miss-islington @erlend-aasland @ezio-melotti
[3.12] Docs: Argument Clinic: Add Background and Tutorial top-level s…
1a3766b
…ections (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 81861fd)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
erlend-aasland added a commit that referenced this pull request Jul 21, 2023
@miss-islington @erlend-aasland @ezio-melotti
[3.11] Docs: Argument Clinic: Add Background and Tutorial top-level s…
0a57620
…ections (GH-106904) (#106946)

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]>
erlend-aasland added a commit to erlend-aasland/devguide that referenced this pull request Sep 8, 2023
@erlend-aasland @ezio-melotti
Docs: Argument Clinic: Add Background and Tutorial top-level sections (…
d7dee62
…python/cpython#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 <[email protected]>
AA-Turner pushed a commit to AA-Turner/devguide that referenced this pull request Sep 13, 2023
@erlend-aasland @ezio-melotti
Docs: Argument Clinic: Add Background and Tutorial top-level sections (…
60a674b
…python/cpython#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 <[email protected]>
erlend-aasland added a commit to python/devguide that referenced this pull request Sep 26, 2023
@erlend-aasland @ezio-melotti
Docs: Argument Clinic: Add Background and Tutorial top-level sections (…
9f20a12
…python/cpython#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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezio-melotti ezio-melotti ezio-melotti 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.

4 participants

@erlend-aasland @miss-islington @bedevere-bot @ezio-melotti
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.