microsoft / microsoft/azure-devops-python-api
docstrings are inconsistent making Sphinx documentation not display properly
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 684
- Forks
- 218
- Ø Merge
- 8 T. 10 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
Related to Issue: https://github.com/microsoft/azure-devops-python-api/issues/349
When using Sphinx to build documentation for this Python module, it appears that there are some modules that do not have appropriate spacing between the summary and the parameters docstrings causing Sphinx to not compile properly.
Some of the docstrings do not have spaces like:
But the functional lines that display properly have space around the description, like:
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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
Vergleiche zunächst die Docstrings in azure-devops/azure/devops/v7_0/build/build_client.py (etwa in den Zeilen 14–18) mit denen in azure-devops/azure/devops/v7_0/build/models.py (etwa in den Zeilen 12–26). Erstelle die Sphinx-Dokumentation, um die Formatierungsfehler zu identifizieren, überprüfe anschließend die betroffenen Modul-Docstrings und bestätige, dass die Dokumentation erfolgreich kompiliert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100