docstrings are inconsistent making Sphinx documentation not display properly
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 45/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
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.
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:
- Vorherrschende Sprache
- Python
- Sterne
- 684
- Forks
- 218
- Ø Merge
- 8 T. 10 Std.
- Gemergte PRs (30 T.)
- 1
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus microsoft/azure-devops-python-api
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 55/100
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 55/100
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
Alle Issues in microsoft/azure-devops-python-api
Ähnliche Issues
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
stephrobert/dsoxlab#238 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
sublimehq/package_control#1780 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
nwg-piotr/nwg-displays#145 ·