docstrings are inconsistent making Sphinx documentation not display properly
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia confrontando i docstring in azure-devops/azure/devops/v7_0/build/build_client.py (intorno alle righe 14–18) con quelli in azure-devops/azure/devops/v7_0/build/models.py (intorno alle righe 12–26). Genera la documentazione Sphinx per identificare gli errori di formattazione, quindi controlla i docstring dei moduli interessati e conferma che la documentazione venga compilata correttamente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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:
- Lingua principale
- Python
- Stelle
- 684
- Fork
- 218
- Merge medio
- 8g 10h
- PR unite (30g)
- 1
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoft/azure-devops-python-api
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
README sample code has a bug Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 55/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
Tutte le issue di microsoft/azure-devops-python-api
Issue simili
-
from:qa priority:P2 reliability tech-debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
spec-kitty/spec-kitty#4874 ·
-
fix: inaccuracy ⚠️
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
uabrc/uabrc.github.io#1255 · 1 commento ·
-
kind:bug needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
docs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
ethereum-optimism/factory#64 ·