8000 Docs: Argument Clinic: Improve 'How to write a custom converter' by erlend-aasland · Pull Request #107328 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

Docs: Argument Clinic: Improve 'How to write a custom converter' #107328

8000
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

erlend-aasland
Copy link
Contributor
@erlend-aasland erlend-aasland commented Jul 26, 2023
  • Move the CConverter class reference to the reference (reverted; will make a separate PR for this)
  • Omit unneccesary wording and sentences
  • Don't mention implementation details (no digression, explanation)

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

- Move the CConverter class reference to the reference
- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)
@erlend-aasland
Copy link
Contributor Author

Follow-up PRs: chose a better example (the current example is not even valid; there is no Py_ssize_t converter in zlibmodule.c. Also, it is not the simplest possible converter, as the current howto states. We also need to sync the CConverter class reference so it's up to date with the clinic source code.

@erlend-aasland
Copy link
Contributor Author

FTR, I reverted moving the CConverter reference to the Reference section, to make this easier to review.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@erlend-aasland erlend-aasland enabled auto-merge (squash) August 5, 2023 20:08
@erlend-aasland erlend-aasland merged commit 4a5b422 into python:main Aug 5, 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-107669 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 5, 2023
…honGH-107328)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

(cherry picked from commit 4a5b422)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 5, 2023
@bedevere-bot
Copy link

GH-107670 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 Aug 5, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 5, 2023
…honGH-107328)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

(cherry picked from commit 4a5b422)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@erlend-aasland erlend-aasland deleted the clinic-docs/reference-converters branch August 5, 2023 20:24
@erlend-aasland
Copy link
Contributor Author

Thanks for the review, Ezio!

erlend-aasland added a commit that referenced this pull request Aug 5, 2023
…r' (GH-107328) (#107670)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

(cherry picked from commit 4a5b422)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Yhg1s pushed a commit that referenced this pull request Aug 6, 2023
…r' (GH-107328) (#107669)

Docs: Argument Clinic: Improve 'How to write a custom converter' (GH-107328)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

(cherry picked from commit 4a5b422)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
erlend-aasland added a commit to erlend-aasland/devguide that referenced this pull request Sep 8, 2023
…hon/cpython#107328)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
AA-Turner pushed a commit to AA-Turner/devguide that referenced this pull request Sep 13, 2023
…hon/cpython#107328)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
erlend-aasland added a commit to python/devguide that referenced this pull request Sep 26, 2023
…hon/cpython#107328)

- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0