Skip to content
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

Replace the "goals of Argument Clinic" with a link to PEP 436 #107507

Closed
erlend-aasland opened this issue Jul 31, 2023 · 0 comments · Fixed by #107508
Closed

Replace the "goals of Argument Clinic" with a link to PEP 436 #107507

erlend-aasland opened this issue Jul 31, 2023 · 0 comments · Fixed by #107508
Labels
docs Documentation in the Doc dir

Comments

@erlend-aasland
Copy link
Contributor

erlend-aasland commented Jul 31, 2023 •
edited by bedevere-bot
Loading

The Argument Clinic howto starts with six paragraphs about the goals of Argument Clinic, mostly repeating the motivation and rationale of PEP-436. Here's a quick run-through of the paragraphs:

  1. AC should take over arg parsing in CPython.
  2. Hand-written arg parsing code is a chore; AC must be easy to use.
  3. AC must generate correct and hopefully fast code; also an outdated section about the possibility of generating tailor made code for various cases.
  4. AC should support all of CPython's "strange parsing behaviours".
  5. AC should provide introspection signatures for builtins.
  6. The last paragraph repeats information present in the tutorial.

Suggesting to remove the whole "The goals of Argument Clinic", and instead provide a short summary (one or two sentences) and link to PEP-436.

Linked PRs
@erlend-aasland erlend-aasland added the docs Documentation in the Doc dir label Jul 31, 2023
@bedevere-bot bedevere-bot mentioned this issue Jul 31, 2023
Merged
@erlend-aasland erlend-aasland linked a pull request Jul 31, 2023 that will close this issue
gh-107507: Replace 'The goals of Argument Clinic' with a summary #107508
Merged
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Jul 31, 2023
@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.
erlend-aasland added a commit that referenced this issue Jul 31, 2023
@erlend-aasland
gh-107507: Replace 'The goals of Argument Clinic' with a summary (#10…
abb71c6 
…7508)

Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
This was referenced Jul 31, 2023
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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 issue 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 issue 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 issue 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]>
AA-Turner pushed a commit to AA-Turner/devguide that referenced this issue 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 issue 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
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-107507: Replace 'The goals of Argument Clinic' with a summary erlend-aasland/cpython
1 participant
@erlend-aasland