gh-109070: Document that multiprocessing.get_context() sets the global context
#109488
Conversation
|
All commit authors signed the Contributor License Agreement. |
multiprocessing.get_context() sets the global context
|
@AA-Turner please review this PR |
|
@AA-Turner @alex @phsilva @scw anybody review the PR |
|
Please do not ping people at random on PRs, it's bad form. See the developer's guide; all reviewers are volunteers with limited time. A |
Doc/library/multiprocessing.rst
Outdated
| @@ -1049,27 +1049,25 @@ Miscellaneous | |||
|
|
|||
| .. function:: get_context(method=None) | |||
|
|
|||
| Return a context object which has the same attributes as the | |||
| :mod:`multiprocessing` module. | |||
| Return a context object with the same attributes as the :mod:`multiprocessing` module. | |||
There was a problem hiding this comment.
We tend to avoid unrelated changes, pleas revert the change to the summary line.
Doc/library/multiprocessing.rst
Outdated
| Otherwise *method* should be ``'fork'``, ``'spawn'``, | ||
| ``'forkserver'``. :exc:`ValueError` is raised if the specified | ||
| start method is not available. See :ref:`multiprocessing-start-methods`. | ||
| If *method* is ``None``, the default context is returned. Be aware that calling this function with *method=None* sets the default context globally, potentially affecting future usage of :func:`set_start_method`. To change the method later, it is recommended to explicitly specify a method other than ``None`` when calling this function. Otherwise, it may lead to unexpected behavior. |
There was a problem hiding this comment.
This is now one incredibly long line. Please revert the change, and limit new lines to 79 characters long.
Doc/library/multiprocessing.rst
Outdated
|
|
||
| .. versionadded:: 3.4 | ||
|
|
||
| .. function:: get_start_method(allow_none=False) | ||
|
|
||
| Return the name of start method used for starting processes. | ||
| Return the name of the start method used for initiating processes. |
There was a problem hiding this comment.
Again, please revert the change to this line
Doc/library/multiprocessing.rst
Outdated
| If the start method has not been explicitly set (e.g., using :func:`set_start_method`) and *allow_none* is false, then the start method is fixed to the default, and the name of the default method is returned. If the start method has not been explicitly set and *allow_none* is true, then ``None`` is returned, indicating that the method has not been explicitly set. | ||
|
|
||
| The return value can be one of the following: ``'fork'``, ``'spawn'``, ``'forkserver'``, or ``None``. | ||
|
|
||
| If the start method has not been fixed and *allow_none* is false, | ||
| then the start method is fixed to the default and the name is | ||
| returned. If the start method has not been fixed and *allow_none* | ||
| is true then ``None`` is returned. | ||
| .. note:: Exercise caution when changing the start method using ``multiprocessing.set_start_method`` after using ``multiprocessing.get_start_method`` with *allow_none* set to ``False``, as it may raise a ``RuntimeError``. | ||
|
|
||
| The return value can be ``'fork'``, ``'spawn'``, ``'forkserver'`` | ||
| or ``None``. See :ref:`multiprocessing-start-methods`. | ||
| See :ref:`multiprocessing-start-methods` for more information on multiprocessing start methods and their implications. |
There was a problem hiding this comment.
Please add your changes on new lines and limit unrelated changes.
|
Oh, seems the review summary comment got lost, sorry. In brief: It's much harder to review the actual changes to the text when there are many whitespace changes, moving content around, etc. You could open a new PR if you want to edit these words, but each individual PR should stay focussed. You may find it useful to consult the Developer's Guide, especially the overview to documentation and the lifecycle of a pull request. A |
Okay I Have read it. can you tell which linting tool is used by cpython to check the linting of rst files locally |
The page I linked notes this around halfway through: https://devguide.python.org/documentation/start-documenting/#build-using-make-make-bat A |
|
The following commit authors need to sign the Contributor License Agreement: |
📚 Documentation preview 📚: https://cpython-previews--109488.org.readthedocs.build/