gh-1269: Added references for argument clinic directives#1465
Open
Lincoln-developer wants to merge 4 commits intopython:mainfrom
Open
gh-1269: Added references for argument clinic directives#1465Lincoln-developer wants to merge 4 commits intopython:mainfrom
Lincoln-developer wants to merge 4 commits intopython:mainfrom
Conversation
erlend-aasland
requested changes
Nov 4, 2024
Contributor
erlend-aasland
left a comment
erlend-aasland
left a comment
There was a problem hiding this comment.
I think we should add this directly to the Argument Clinic docs; adding them as a separate page is going to be confusing.
Contributor
Author
Okay, thanks for the review. Let me work on the requested changes. |
AA-Turner
reviewed
Nov 4, 2024
AA-Turner
reviewed
Nov 4, 2024
development-tools/clinic.rst
Outdated
Comment on lines
2449
to
2454
| **Description**: | ||
| The ``destination`` directive allows for operations on output destinations. | ||
|
|
||
| **Parameters**: | ||
| - The ``destination`` directive takes in two arguments ``(destination [arg1] [arg2])``. | ||
| - Where ``arg1`` is the ``name`` of the output destination and ``arg2`` is the ``command`` on the output destination. |
Member
There was a problem hiding this comment.
Do you intend these to be definition lists? If not the indentation should be removed.
Contributor
Author
There was a problem hiding this comment.
@AA-Turner thanks for this insight, yeah! indeed to improve clarity its better not to make the content appear as a definition list.
Adjusted output destination list formatting as per feedback. Co-authored-by: Adam Turner <[email protected]>
|
All commit authors signed the Contributor License Agreement. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This pull request introduces references for argument clinic directives.
📚 Documentation preview 📚: https://cpython-devguide--1465.org.readthedocs.build/