python / python/cpython

Misplaced or duplicated function descriptions in the multiprocessing documentation

Offen
#97,847 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs topic-multiprocessing
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):

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

Linked PRs
  • gh-31482

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Ö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

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.