Docs: Argument Clinic: Restructure "Basic concepts and usage" #106981
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts
bedevere-bot
added
awaiting core review
docs
erlend-aasland
commented
Jul 21, 2023
|
I'm not quite satisfied with this yet, but I'm throwing it out now, to have some more eyes on it. Hopefully, this is a step in the right direction. I considered making the "Basic usage" thing the introduction; that is, no title, no section; just a plain introduction just after the abstract. Perhaps that is an idea to follow. Anyways, I think it makes sense to create a reference section and put the CLI usage and terminology there. On a longer term, we'll probably also fill it up with stuff like the CConverter class. |
AA-Turner
reviewed
Jul 22, 2023
Co-authored-by: Ezio Melotti <[email protected]> Co-authored-by: Adam Turner <[email protected]>
…a C block comment
|
Thanks for the reviews! Does the overall change make sense to you? |
|
@AlexWaygood, are you interested in reviewing this? |
AlexWaygood
reviewed
Jul 24, 2023
AlexWaygood
reviewed
Jul 24, 2023
AlexWaygood
reviewed
Jul 24, 2023
AlexWaygood
reviewed
Jul 24, 2023
|
@AlexWaygood, are you ok with the last changes? |
AlexWaygood
reviewed
Jul 26, 2023
|
I'm landing this now; there'll be plenty of time for docs tweaks later :) |
|
Thanks for the valuable reviews, everyone! |
erlend-aasland
added
needs backport to 3.11
|
Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11. |
|
Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Sorry, @erlend-aasland, I could not cleanly backport this to |
|
GH-107325 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
Jul 26, 2023
…GH-106981) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts (cherry picked from commit 2ad6990) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
|
GH-107327 is a backport of this pull request to the 3.11 branch. |
erlend-aasland
added a commit
to erlend-aasland/cpython
that referenced
this pull request
Jul 26, 2023
…ython#106981) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts (cherry picked from commit 2ad6990) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
erlend-aasland
added a commit
that referenced
this pull request
Jul 26, 2023
…106981) (#107327) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts (cherry picked from commit 2ad6990) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
jtcave
pushed a commit
to jtcave/cpython
that referenced
this pull request
Jul 27, 2023
…#106981) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
erlend-aasland
added a commit
that referenced
this pull request
Jul 27, 2023
…H-106981) (#107325) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts (cherry picked from commit 2ad6990) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
erlend-aasland
added a commit
to erlend-aasland/devguide
that referenced
this pull request
Sep 8, 2023
…/cpython#106981) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
AA-Turner
added a commit
to AA-Turner/devguide
that referenced
this pull request
Sep 13, 2023
…/cpython#106981) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
erlend-aasland
added a commit
to python/devguide
that referenced
this pull request
Sep 26, 2023
…/cpython#106981) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Split "Basic concepts and usage" into:
Reference
Background
📚 Documentation preview 📚: https://cpython-previews--106981.org.readthedocs.build/