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

Documentation for os.exec* functions omits information about required argument #125562

Open
jlownie opened this issue Oct 16, 2024 · 0 comments
Open
Labels
docs Documentation in the Doc dir

Comments

@jlownie
Copy link

jlownie commented Oct 16, 2024

Documentation

All of the os.exec* functions (there are 8) require the path to the executable to be the first argument given to the executable, as well as specified in the path or file parameter of the exec method. The documentation of the exec* functions doesn't include any information about this requirement, however it can be found at the start of the Process management section of the documentation. I think it should be moved to the exec* function documentation.

Additionally I personally think that the discussion of the different variants of the function is a bit confusing and would be easier to understand if it was structured differently and a few headings were added.

I have some ideas about how to do this and intend to put together a pull request addressing the issues.

Linked PRs

@jlownie jlownie added the docs Documentation in the Doc dir label Oct 16, 2024
jlownie added a commit to jlownie/cpython that referenced this issue Oct 16, 2024
jlownie added a commit to jlownie/cpython that referenced this issue Oct 16, 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
Projects
None yet
Development

No branches or pull requests

1 participant