Doc: Add missing spaces after period for posix_spawn
#22730
Conversation
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA). Recognized GitHub usernameWe couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames: This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
Doc/library/os.rst
Outdated
| The *path* parameter is the path to the executable file. The *path* should | ||
| contain a directory. Use :func:`posix_spawnp` to pass an executable file |
There was a problem hiding this comment.
Nice catch! A minor nitpick I have is that PEP 12 states:
You must adhere to the Emacs convention of adding two spaces at the end of every sentence
Although I realized most of the docs are inconsistent with this and it's not strictly adhered to, I thought I'd just point it out.
| The *path* parameter is the path to the executable file. The *path* should | |
| contain a directory. Use :func:`posix_spawnp` to pass an executable file | |
| The *path* parameter is the path to the executable file. The *path* should | |
| contain a directory. Use :func:`posix_spawnp` to pass an executable file |
There was a problem hiding this comment.
I'm not sure why the two spaces convention is useful for, but it can be automated easily. I'm adding another commit for this below, feel free to squash them into one.
sed -i "s/\.\ \([A-Z]\)/\.\ \ \1/g" os.rstThere was a problem hiding this comment.
Yeah, I don't use Emacs so I'm not able to justify them either. Personally, I'd recommend the automated adding of spaces be part of a separate PR (and just add the spaces for your own edits for this one) since this might make it harder for the core devs to review. Changes that fix a styling problem should probably go into another PR https://devguide.python.org/pullrequest/#making-good-commits. Sorry if I created confusion regarding what was to be fixed!
Edit: When PRs are merged, they are squash-ed into a single commit, so you don't have to squash the commits yourself.
There was a problem hiding this comment.
Dropped the second commit, added double spaces only to the changed lines.
methane
changed the title
posix_spawn
(cherry picked from commit 5b57fa6) Co-authored-by: Tomer Cohen <[email protected]>
|
GH-22809 is a backport of this pull request to the 3.9 branch. |
(cherry picked from commit 5b57fa6) Co-authored-by: Tomer Cohen <[email protected]>
|
GH-22810 is a backport of this pull request to the 3.8 branch. |
(cherry picked from commit 5b57fa6) Co-authored-by: Tomer Cohen <[email protected]>
(cherry picked from commit 5b57fa6) Co-authored-by: Tomer Cohen <[email protected]>
No description provided.