python / python/cpython

Misplaced or duplicated function descriptions in the multiprocessing documentation

Open
#97,847 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs topic-multiprocessing
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

Documentation

In the documentation of the multiprocessing module, some public functions of the root module are undocumented but their submodule counterparts are (misplaced information):

And some public functions of the root module are documented but also their submodule counterparts (duplicated information):

Linked PRs
  • gh-31482

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the multiprocessing documentation page and compare the root-module entries with the sharedctypes and pool sections. Check the corresponding exports in Lib/multiprocessing/context.py, then update the documentation so RawValue, RawArray, and Pool are covered while Value and Array are not duplicated; gh-31482 is listed as a linked PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.