FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-1269: Added references for argument clinic directives by Lincoln-developer · Pull Request #1465 · python/devguide · GitHub

/ devguide Public

gh-1269: Added references for argument clinic directives - #1465

Open
Lincoln-developer wants to merge 4 commits into
python:mainfrom
Lincoln-developer:fix-issue-1269
ConversationCommits (4)ChecksFiles changed
Open

gh-1269: Added references for argument clinic directives#1465
Lincoln-developer wants to merge 4 commits into
python:mainfrom
Lincoln-developer:fix-issue-1269

Conversation

Lincoln-developer commented Nov 4, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

This pull request introduces references for argument clinic directives.

📚 Documentation preview 📚: https://cpython-devguide--1465.org.readthedocs.build/

erlend-aasland requested changes Nov 4, 2024
View reviewed changes

erlend-aasland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think we should add this directly to the Argument Clinic docs; adding them as a separate page is going to be confusing.

Lincoln-developer commented Nov 4, 2024

Copy link
Copy Markdown
Contributor Author

I think we should add this directly to the Argument Clinic docs; adding them as a separate page is going to be confusing.

Okay, thanks for the review. Let me work on the requested changes.

AA-Turner reviewed Nov 4, 2024
View reviewed changes
Comment thread development-tools/clinic.rst Outdated
AA-Turner reviewed Nov 4, 2024
View reviewed changes
Comment thread 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.

AA-Turner Nov 4, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Do you intend these to be definition lists? If not the indentation should be removed.

Lincoln-developer Nov 5, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@AA-Turner thanks for this insight, yeah! indeed to improve clarity its better not to make the content appear as a definition list.

Lincoln-developer and others added 2 commits November 5, 2024 08:38
Update development-tools/clinic.rst
bd2b1de 
Adjusted output destination list formatting as per feedback.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Adjusted list formatting as per feedback
8112789

python-cla-bot Bot commented Apr 18, 2025 •
edited
Loading

Copy link
Copy Markdown

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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AA-Turner AA-Turner left review comments
erlend-aasland Awaiting requested review from erlend-aasland

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL