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

subprocess module docs contain an inconsistent mix of repeated versionchanged descriptions #101715

Open
gpshead opened this issue Feb 8, 2023 · 1 comment
Labels
docs Documentation in the Doc dir topic-subprocess Subprocess issues.

Comments

@gpshead
Copy link
Member

gpshead commented Feb 8, 2023

Documentation

The subprocess module documentation has an explosion of repeated text in versionchanged or versionadded markers splattered over multiple APIs within the docs.

The reality is that many of these are technically all directly Popen API changes, that the other higher level preferred more user friendly APIs like run() and call() and check_call() and check_output() all make use of internally and forward a majority of their arguments to.

Examples to look for: where are cwd, input, text, encoding, errors argument behavior changes/additions mentioned vs which APIs accept these.

I noticed this when looking over the changes made in #101283 where it became apparent to me that we're not internally consistent in how we do this within the doc today. The doc needs some cleanup and a strategy for this.

@gpshead gpshead added the docs Documentation in the Doc dir label Feb 8, 2023
@bzip2
Copy link

bzip2 commented Aug 30, 2023

errors is not explained at all.

It might be helpful to have a table showing which combinations of arguments you can use together, and what they do.

@vstinner vstinner added the topic-subprocess Subprocess issues. label Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-subprocess Subprocess issues.
Projects
None yet
Development

No branches or pull requests

3 participants