Misplaced or duplicated function descriptions in the multiprocessing documentation
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 36k
- Métriques de merge des PR
- Métriques de PR en attente
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):
multiprocessing.RawValueis undocumented butmultiprocessing.sharedctypes.RawValueis documented;multiprocessing.RawArrayis undocumented butmultiprocessing.sharedctypes.RawArrayis documented;multiprocessing.Poolis undocumented butmultiprocessing.pool.Poolis documented.
And some public functions of the root module are documented but also their submodule counterparts (duplicated information):
multiprocessing.Valueis documented andmultiprocessing.sharedctypes.Valueis documented;multiprocessing.Arrayis documented andmultiprocessing.sharedctypes.Arrayis documented.
Linked PRs
- gh-31482
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la page de documentation de multiprocessing et comparez les entrées du module racine avec les sections sharedctypes et pool. Vérifiez les exports correspondants dans Lib/multiprocessing/context.py, puis mettez à jour la documentation afin que RawValue, RawArray et Pool soient couverts, tandis que Value et Array ne soient pas dupliqués ; gh-31482 est répertorié comme un PR lié.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 30/100