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 — gh-106799: Pick another example method for Argument Clinic How-To by littlebutt · Pull Request #106800 · python/cpython

Conversation

@littlebutt

@littlebutt littlebutt commented Jul 16, 2023 •
edited by github-actions Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor
  • Pick another example method for Argument Clinic How-To
  • Issue: Argument Clinic How-To needs more examples devguide#1190

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

Sorry, something went wrong.

Uh oh!

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

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
littlebutt and others added 9 commits July 9, 2023 10:45
@littlebutt
pythongh-104469 Convert_testcapi/vectorcall.c to use AC
2442d02
@littlebutt
fix method names
291f92f
@littlebutt @corona10
Update Modules/_testcapi/vectorcall.c
fcf998f
Co-authored-by: Dong-hee Na <[email protected]>
@littlebutt
run build.bat --regen to fix CI
5ee06e7
@littlebutt
Merge branch 'python:main' into main
92d897b
@littlebutt
Merge branch 'main' into main
24dd765
@littlebutt
Merge branch 'python:main' into main
ed29f9e
@littlebutt
Merge branch 'python:main' into main
4aedea8
@littlebutt
gh-106799: pick another method to illustrate AC
cf11d8d
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 16, 2023
@littlebutt littlebutt mentioned this pull request Oct 12, 2023
Argument Clinic How-To needs more examples python/devguide#1190
Open
@erlend-aasland
erlend-aasland requested review from AlexWaygood and erlend-aasland July 16, 2023 05:48
@littlebutt

littlebutt commented Jul 17, 2023

Copy link
Copy Markdown
Contributor Author

Hi @erlend-aasland, I know you are interested in AC. Could you take a look at the PR. Is it necessary to change the example used in the article. Thank you very much.

erlend-aasland and olife-png reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

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

@erlend-aasland

erlend-aasland commented Jul 17, 2023

Copy link
Copy Markdown
Contributor

Hi, @littlebutt! I've already added Alex and myself as reviewers. I'll try to review it within this week. If not, feel free to ping me :)

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@erlend-aasland

erlend-aasland commented Jul 17, 2023

Copy link
Copy Markdown
Contributor

Also, it is very nice to see some interest in improving the clinic docs!

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@littlebutt

littlebutt commented Jul 17, 2023

Copy link
Copy Markdown
Contributor Author

Hi, @littlebutt! I've already added Alex and myself as reviewers. I'll try to review it within this week. If not, feel free to ping me :)

Thank you!

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

erlend-aasland
erlend-aasland reviewed Jul 17, 2023
View reviewed changes
Comment thread Doc/howto/clinic.rst Resolved

Uh oh!

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

littlebutt added 2 commits July 18, 2023 21:00
@littlebutt
modify the example function to fit all cases
e1a05cc
@littlebutt
Merge branch 'main' into change_an_example_for_clinic
9fbc42b
@littlebutt

littlebutt commented Jul 18, 2023

Copy link
Copy Markdown
Contributor Author

Hi @erlend-aasland , I modify the origin function to fit all cases in the document. Is it okay with you? Also, I changed some examples before the converter step. Because readers will confuse when they meet converter ahead of its introduction.

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@erlend-aasland
erlend-aasland requested a review from ezio-melotti July 19, 2023 11:12
@erlend-aasland

erlend-aasland commented Jul 19, 2023

Copy link
Copy Markdown
Contributor

cc. @serhiy-storchaka @ezio-melotti

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@erlend-aasland

erlend-aasland commented Jul 20, 2023

Copy link
Copy Markdown
Contributor

@littlebutt, I worry that this change is premature; the clinic tutorial definitely needs an overhaul, but I think we need to do some basic adjustments before we get to the part where we tear out the existing example. I started doing some adjustments to the clinic docs in small steps (see #106876 and #106904).

Here's a very course plan:

  1. get rid of the numbered list
  2. in multiple steps, align the language of the tutorial with the Diátaxis recommendations -- hopefully, it will shrink in size :)
  3. start reworking the example used in the tutorial (this PR!)

What do you think? :)

olife-png reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@littlebutt

littlebutt commented Jul 20, 2023

Copy link
Copy Markdown
Contributor Author

@littlebutt, I worry that this change is premature; the clinic tutorial definitely needs an overhaul, but I think we need to do some basic adjustments before we get to the part where we tear out the existing example. I started doing some adjustments to the clinic docs in small steps (see #106876 and #106904).

Here's a very course plan:

  1. get rid of the numbered list

  2. in multiple steps, align the language of the tutorial with the Diátaxis recommendations -- hopefully, it will shrink in size :)

  3. start reworking the example used in the tutorial (this PR!)

What do you think? :)

It sounds like a good idea. The tutorial needs improvement and a single PR obviously cannot change a lot. More effort should be made to optimize the document.

erlend-aasland reacted with thumbs up emoji erlend-aasland and CharlieZhao95 reacted with rocket emoji
All reactions
  • 👍 1 reaction
  • 🚀 2 reactions

Sorry, something went wrong.

Uh oh!

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

@serhiy-storchaka serhiy-storchaka added the topic-argument-clinic label Aug 29, 2023
@erlend-aasland

erlend-aasland commented Oct 12, 2023

Copy link
Copy Markdown
Contributor

The Argument Clinic docs have moved to https://github.com/python/devguide. Please open a new PR over there.

All reactions

Sorry, something went wrong.

Uh oh!

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

@erlend-aasland erlend-aasland closed this Oct 12, 2023
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 left review comments
@AlexWaygood AlexWaygood Awaiting requested review from AlexWaygood
@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti

Uh oh!

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

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news topic-argument-clinic

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

@littlebutt @erlend-aasland @serhiy-storchaka @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.