Skip to content

gh-107507: Replace 'The goals of Argument Clinic' with a summary #107508

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 31, 2023
Merged

gh-107507: Replace 'The goals of Argument Clinic' with a summary #107508

merged 1 commit into from
Jul 31, 2023

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jul 31, 2023 •
edited by github-actions bot
Loading

Instead of repeating the rationale and motivation of PEP-436,
reword the Abstract to provide a summary of the goals of AC.

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

@erlend-aasland
pythongh-107507: Replace 'The goals of Argument Clinic' with a summary
4a075b2 
Instead of repeating the rationale and motivation of PEP-436,
reword the Abstract to provide a summary of the goals of AC.
@bedevere-bot bedevere-bot mentioned this pull request Jul 31, 2023
Closed
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 31, 2023
@erlend-aasland erlend-aasland linked an issue Jul 31, 2023 that may be closed by this pull request
Replace the "goals of Argument Clinic" with a link to PEP 436 #107507
Closed
@erlend-aasland
Copy link
Contributor Author

(Oh my, I can't believe I didn't create a feature branch for this PR 😅)

AlexWaygood
AlexWaygood reviewed Jul 31, 2023
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I thought the current policy was that PEPs were meant to be historical documents rather than living documentation, and that we should ideally have all relevant documentation in the CPython repo rather than referring people to PEPs. For the typing docs, we're trying to move away from constant references to the typing PEPs (though progress has been slow on achieving that)

@erlend-aasland
Copy link
Contributor Author

Hmm, I thought the current policy was that PEPs were meant to be historical documents rather than living documentation, and that we should ideally have all relevant documentation in the CPython repo rather than referring people to PEPs. For the typing docs, we're trying to move away from constant references to the typing PEPs (though progress has been slow on achieving that)

For this change, I think the existing text is way to elaborate; the goals of Argument Clinic can be summarised in a single sentence.

Also, we don't refer to the PEP as such, we only point out that Argument Clinic was introduced with a PEP.

AlexWaygood
AlexWaygood approved these changes Jul 31, 2023
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I think my initial reaction to this PR was overly coloured by the title you gave to the linked issue. Reading it over again, you're right that none of this information is relevant to users of argument clinic. This definitely improves things!

@erlend-aasland
Copy link
Contributor Author

Thanks for the review, Ezio and Alex!

@erlend-aasland erlend-aasland merged commit abb71c6 into python:main Jul 31, 2023
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 31, 2023
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 31, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 31, 2023
@erlend-aasland @miss-islington
pythongh-107507: Replace 'The goals of Argument Clinic' with a summary (
b68c50c 
pythonGH-107508)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
(cherry picked from commit abb71c6)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 31, 2023
@erlend-aasland @miss-islington
pythongh-107507: Replace 'The goals of Argument Clinic' with a summary (
e990fef 
pythonGH-107508)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
(cherry picked from commit abb71c6)

Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland added a commit that referenced this pull request Jul 31, 2023
@miss-islington @erlend-aasland
[3.12] gh-107507: Replace 'The goals of Argument Clinic' with a summa…
fd60855 
…ry (GH-107508) (#107516)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
(cherry picked from commit abb71c6)

Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland added a commit that referenced this pull request Jul 31, 2023
@miss-islington @erlend-aasland
[3.11] gh-107507: Replace 'The goals of Argument Clinic' with a summa…
3be07c9 
…ry (GH-107508) (#107517)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
(cherry picked from commit abb71c6)

Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland added a commit to erlend-aasland/devguide that referenced this pull request Sep 8, 2023
@erlend-aasland
gh-107507: Replace 'The goals of Argument Clinic' with a summary (pyt…
6cd2f18 
…hon/cpython#107508)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
AA-Turner pushed a commit to AA-Turner/devguide that referenced this pull request Sep 13, 2023
@erlend-aasland
python/cpython#107507: Replace 'The goals of Argument Clinic' with a …
64b07f5 
…summary (python/cpython#107508)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
erlend-aasland added a commit to python/devguide that referenced this pull request Sep 26, 2023
@erlend-aasland
python/cpython#107507: Replace 'The goals of Argument Clinic' with a …
5326a44 
…summary (python/cpython#107508)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
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

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Replace the "goals of Argument Clinic" with a link to PEP 436
5 participants
@erlend-aasland @miss-islington @bedevere-bot @ezio-melotti @AlexWaygood