Skip to content

gh-101100: Fix reference to parse_args in optparse.rst #105265

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 28, 2023
Merged

gh-101100: Fix reference to parse_args in optparse.rst #105265

merged 4 commits into from
Jun 28, 2023

Conversation

ghost
Copy link

@ghost ghost commented Jun 3, 2023 •
edited by github-actions bot
Loading

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jun 3, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jun 3, 2023
Open
hugovk
hugovk requested changes Jun 5, 2023
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks for the PR.

However, this currently updates the links to point to the parse_args method of the argparse module, when it should be pointing to the parse_args method of this optparse module.

The reason we're getting warnings is because the optparse's parse_args doesn't yet have documentation in this optparse.rst file.

It does have a docstring, so that could be used as a starting point for adding it here:

cpython/Lib/optparse.py

Line 1355 in dbc179e

def parse_args(self, args=None, values=None):

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@hugovk hugovk added the pending The issue will be closed if no feedback is provided label Jun 5, 2023
@ghost
Copy link
Author

ghost commented Jun 28, 2023

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@hugovk: please review the changes made to this pull request.

@bedevere-bot bedevere-bot requested a review from hugovk June 28, 2023 06:54
@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jun 28, 2023
@hugovk
Copy link
Member

hugovk commented Jun 28, 2023

Thank you!

@hugovk hugovk merged commit 18f51f9 into python:main Jun 28, 2023
@miss-islington
Copy link
Contributor

Thanks @F3eQnxN3RriK for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-106204 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jun 28, 2023
@bedevere-bot
Copy link

GH-106205 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 Jun 28, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 28, 2023
@miss-islington
pythongh-101100: Fix reference to parse_args in optparse.rst (pyt…
5a4cdce 
…honGH-105265)

(cherry picked from commit 18f51f9)

Co-authored-by: F3eQnxN3RriK <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 28, 2023
@miss-islington
pythongh-101100: Fix reference to parse_args in optparse.rst (pyt…
e9c4303 
…honGH-105265)

(cherry picked from commit 18f51f9)

Co-authored-by: F3eQnxN3RriK <[email protected]>
@ghost ghost deleted the doc-patch-1 branch June 28, 2023 12:32
hugovk pushed a commit that referenced this pull request Jun 28, 2023
@miss-islington
[3.11] gh-101100: Fix reference to parse_args in optparse.rst (GH…
ce091c9 
…-105265) (#106205)

Co-authored-by: F3eQnxN3RriK <[email protected]>
hugovk pushed a commit that referenced this pull request Jun 28, 2023
@miss-islington
[3.12] gh-101100: Fix reference to parse_args in optparse.rst (GH…
0cd07b3 
…-105265) (#106204)

Co-authored-by: F3eQnxN3RriK <[email protected]>
@AA-Turner AA-Turner removed the pending The issue will be closed if no feedback is provided label Apr 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bedevere-bot @hugovk @miss-islington @AA-Turner