Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-106799: Pick another example method for Argument Clinic How-To#106800

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed

Conversation

littlebutt
Copy link
Contributor

@littlebuttlittlebutt commentedJul 16, 2023
edited by github-actionsbot
Loading

  • Pick another example method for Argument Clinic How-To

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

olife-png reacted with thumbs up emoji
@littlebutt
Copy link
ContributorAuthor

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

@erlend-aasland
Copy link
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

@erlend-aasland
Copy link
Contributor

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

olife-png reacted with thumbs up emoji

@littlebutt
Copy link
ContributorAuthor

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

@littlebutt
Copy link
ContributorAuthor

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 beforethe converter step. Because readers will confuse when they meet converter ahead of its introduction.

olife-png reacted with thumbs up emoji

@erlend-aasland
Copy link
Contributor

cc.@serhiy-storchaka@ezio-melotti

olife-png reacted with thumbs up emoji

@erlend-aasland
Copy link
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 theDiá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

@littlebutt
Copy link
ContributorAuthor

@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 theDiá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 emojierlend-aasland and CharlieZhao95 reacted with rocket emoji

@erlend-aasland
Copy link
Contributor

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

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@erlend-aaslanderlend-aaslanderlend-aasland left review comments

@AlexWaygoodAlexWaygoodAwaiting requested review from AlexWaygood

@ezio-melottiezio-melottiAwaiting requested review from ezio-melotti

Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@littlebutt@erlend-aasland@serhiy-storchaka@bedevere-bot

[8]ページ先頭

©2009-2025 Movatter.jp