Misplaced or duplicated function descriptions in the multiprocessing documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der Dokumentationsseite zu multiprocessing und vergleichen Sie die Einträge des Root-Moduls mit den Abschnitten sharedctypes und pool. Prüfen Sie die entsprechenden Exporte in Lib/multiprocessing/context.py und aktualisieren Sie anschließend die Dokumentation so, dass RawValue, RawArray und Pool abgedeckt sind, während Value und Array nicht dupliziert werden; gh-31482 ist als verknüpfter PR aufgeführt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 30/100