microsoft / microsoft/azure-devops-python-api
docstrings are inconsistent making Sphinx documentation not display properly
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 684
- Fork
- 218
- Merge medio
- 8g 10h
- PR unite (30g)
- 1
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:
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.
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.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100