Make docstrings to be nice with pydoc
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1.7k
- Forks
- 408
- Ø Merge
- 2 T. 57 Min.
- Gemergte PRs (30 T.)
- 7
Beschreibung
In some doc-strings we use formatting rules specific to Sphinx, but which make the interactive help (pydoc) to look bad.
This issue is about:
- defining how we should write some recurrent stuff, like documenting input parameters and return values.
- rewrite the doc-strings so they look fine on pydoc, even if that means losing some features with Sphinx, like cross references.
Note. If we had the resources, we would do like Python does, and document things twice: once in the doc-strings and a feature rich version in the rst files. But in any case the doc-strings must be usable with pydoc, so lets start with that.
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
Es werden keine Dateien, Tests oder Einstiegspunkte genannt. Beginne damit, die docstrings des Projekts zu erfassen und ihre gerenderte Ausgabe in pydoc mit den Sphinx-Konventionen zu vergleichen; als abgeschlossen gilt die Aufgabe, wenn Formatierungsregeln für wiederkehrende Parameter und Rückgabewerte vereinbart sind und die docstrings so überarbeitet wurden, dass sie in pydoc weiterhin nutzbar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100