Skip to content

Missing reference to issue in subprocess documentation #105975

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

Closed
swaldhoer opened this issue Jun 21, 2023 · 3 comments
Closed

Missing reference to issue in subprocess documentation #105975

swaldhoer opened this issue Jun 21, 2023 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@swaldhoer
Copy link

swaldhoer commented Jun 21, 2023

Documentation

https://docs.python.org/3/library/subprocess.html#disabling-use-of-vfork-or-posix-spawn references

subprocess._USE_VFORK = False  # See CPython issue gh-NNNNNN.

subprocess._USE_POSIX_SPAWN = False  # See CPython issue gh-NNNNNN.

These are the only missing references I found in the whole docs.

I tried to find the correct issue number, however it was not as easy as expected:
It either is #80004 or #79718.

@swaldhoer swaldhoer added the docs Documentation in the Doc dir label Jun 21, 2023
@JelleZijlstra
Copy link
Member

Possibly the intention is that if you feel the need to set _USE_VFORK to false, you should open a CPython issue and reference it in a comment. However, in that case it's better to be explicit and add a sentence to the docs that says you should open a CPython issue in that case.

@hugovk
Copy link
Member

hugovk commented Jun 21, 2023

Using git blame (https://github.com/python/cpython/blame/main/Doc/library/subprocess.rst), we can see this was added in PR #91490.

@ronaldoussoren
Copy link
Contributor

The end of that section already states:

Please file issues any time you have to use these private knobs with a way to reproduce the issue you were seeing. Link to that issue from a comment in your code.

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
Projects
None yet
Development

No branches or pull requests

4 participants