microsoft / microsoft/azure-devops-python-api
docstrings are inconsistent making Sphinx documentation not display properly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 684
- Forks
- 218
- Avg merge
- 8d 10h
- Merged PRs (30d)
- 1
Description
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:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the docstrings in azure-devops/azure/devops/v7_0/build/build_client.py (around lines 14–18) with azure-devops/azure/devops/v7_0/build/models.py (around lines 12–26). Build the Sphinx documentation to identify the formatting failures, then check the affected module docstrings and confirm the documentation compiles successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100