matplotlib / matplotlib/sampledoc

use the numpydoc package instead of bundling a numpydoc.py file

Offen
#11 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
CSS
Sterne
43
Forks
89
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

numpydoc is now its own project which can be installed with pip or other OS/distribution package managers. Would make sense to remove sphinxext/numpydoc.py from sampledoc?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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

Beginne mit der Untersuchung von sphinxext/numpydoc.py und dem Installations-Setup des Projekts. Entferne das gebündelte Modul zugunsten des externen Pakets numpydoc und überprüfe anschließend, dass sampledoc seine Dokumentationsfunktionalität weiterhin ohne die kopierte Datei bereitstellt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Refactoring
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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