Fix typos in multiprocessing module documentation. #93472
Conversation
|
You don't need NEWS, please delete the file. A |
Looks good, thanks!
On line 1709 there's a directive error -- it should be .. versionchanged:: 3.11 (double colon). Please could you update that? (@JulienPalard out of curiosity do we run sphinx-lint on regular docs PRs? Would this have been caught?)
.. versionchanged: 3.11
Added the *shutdown_timeout* parameter.A
| @@ -2198,10 +2198,10 @@ with the :class:`Pool` class. | |||
| (see :meth:`object.__del__` for more information). | |||
|
|
|||
| .. versionadded:: 3.2 | |||
| *maxtasksperchild* | |||
| *maxtasksperchild*. | |||
There was a problem hiding this comment.
Adding a full stop here seems odd, as it is just noting the name of the parameter that was added. But perhaps it is better style?
There was a problem hiding this comment.
17 out of the 19 occurrences of "New in version" in the docs for this module is followed by a space and either "x.x." or "x.x: <some text>." where "x" is some number. I suggest adding a period for these other two occurrences so that there is consistency. I am happy to delete the suggested periods if you would like me to.
There was a problem hiding this comment.
The comment was more me wondering aloud, please keep as-is.
A
Doc/library/multiprocessing.rst
Outdated
| @@ -2918,12 +2918,12 @@ Beware of replacing :data:`sys.stdin` with a "file like object" | |||
| self._cache = [] | |||
| return self._cache | |||
|
|
|||
| For more information, see :issue:`5155`, :issue:`5313` and :issue:`5331` | |||
| For more information, see :issue:`5155`, :issue:`5313` and :issue:`5331`. | |||
There was a problem hiding this comment.
You could update these to the GitHub numbers and the :gh: role.
There was a problem hiding this comment.
Sure, I have updated line 2921. Do the changes look okay? Thanks!
|
Perhaps don't update the incorrect directive in this PR (please open a new PR for that), as the other fixes should be backported. A |
|
@AA-Turner |
While reading through the
multiprocessingmodule documentation, I identified a few typos / grammatical issues.Given that this relates only to minor typos, I don't think this needs an issue. Please correct me if I am wrong.