Skip to content
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

Jump to bottom

Documentation needs to declare CalledProcessError as potentially resulting from subprocess.run() #87801

Closed
jennievh mannequin opened this issue Mar 26, 2021 · 2 comments
Closed

Documentation needs to declare CalledProcessError as potentially resulting from subprocess.run() #87801

jennievh mannequin opened this issue Mar 26, 2021 · 2 comments
Labels
3.9 docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@jennievh
Copy link
Mannequin

jennievh mannequin commented Mar 26, 2021

BPO 43635
Nosy @jennievh

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-03-26.19:47:45.295>
labels = ['type-feature', '3.9', 'docs']
title = 'Documentation needs to declare CalledProcessError as potentially resulting from subprocess.run()'
updated_at = <Date 2021-03-26.19:47:45.295>
user = 'https://github.com/jennievh'

bugs.python.org fields:

activity = <Date 2021-03-26.19:47:45.295>
actor = 'jennievh'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-03-26.19:47:45.295>
creator = 'jennievh'
dependencies = []
files = []
hgrepos = []
issue_num = 43635
keywords = []
message_count = 1.0
messages = ['389564']
nosy_count = 2.0
nosy_names = ['docs@python', 'jennievh']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue43635'
versions = ['Python 3.9']
@jennievh
Copy link
Mannequin Author

jennievh mannequin commented Mar 26, 2021

The documentation for subprocess says that run() can return CalledProcessError...

https://docs.python.org/3/library/subprocess.html#subprocess.run

...but when you click on the link (5th paragraph down) for CalledProcessError, it only lists check_call() and check_output() as methods that can return it.

My understanding is that check_call(), at least, is (becoming?) deprecated. So this section should definitely mention run():

https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError

@jennievh jennievh mannequin added the 3.9 label Mar 26, 2021
@jennievh jennievh mannequin assigned docspython Mar 26, 2021
@jennievh jennievh mannequin added docs Documentation in the Doc dir 3.9 type-feature A feature request or enhancement labels Mar 26, 2021
@jennievh jennievh mannequin assigned docspython Mar 26, 2021
@jennievh jennievh mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Mar 26, 2021
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@slateny slateny mentioned this issue Apr 17, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 30, 2022
@slateny @miss-islington
pythongh-87801: Add run() to subprocess.CalledProcessError description (
80cc960 
pythonGH-91628)

(cherry picked from commit 567be05)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
JelleZijlstra pushed a commit that referenced this issue Apr 30, 2022
@slateny
gh-87801: Add run() to subprocess.CalledProcessError description (#91628
567be05 
)
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 30, 2022
@slateny @miss-islington
pythongh-87801: Add run() to subprocess.CalledProcessError description (
e844426 
pythonGH-91628)

(cherry picked from commit 567be05)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this issue Apr 30, 2022
@miss-islington @slateny
gh-87801: Add run() to subprocess.CalledProcessError description (GH-…
335aae1 
…91628)

(cherry picked from commit 567be05)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this issue Apr 30, 2022
@miss-islington @slateny
gh-87801: Add run() to subprocess.CalledProcessError description (GH-…
2e84e97 
…91628)

(cherry picked from commit 567be05)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
@hauntsaninja
Copy link
Contributor

hauntsaninja commented May 13, 2022

Thanks, looks like this has been fixed

hello-adam pushed a commit to hello-adam/cpython that referenced this issue Jun 2, 2022
@miss-islington @slateny @hello-adam
pythongh-87801: Add run() to subprocess.CalledProcessError description (
a76d309 
pythonGH-91628)

(cherry picked from commit 567be05)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.9 docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hauntsaninja