azure-devops-python-api icon indicating copy to clipboard operation
azure-devops-python-api copied to clipboard

docstrings are inconsistent making Sphinx documentation not display properly

Open symplrdudley opened this issue 2 years ago • 1 comments

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:

image

https://github.com/microsoft/azure-devops-python-api/blob/b2d0009b2cc457452bc1f8c79b134de877680b06/azure-devops/azure/devops/v7_0/build/build_client.py#L14-L18

But the functional lines that display properly have space around the description, like:

image

https://github.com/microsoft/azure-devops-python-api/blob/b2d0009b2cc457452bc1f8c79b134de877680b06/azure-devops/azure/devops/v7_0/build/models.py#L12-L26

symplrdudley avatar May 01 '23 19:05 symplrdudley

Related to issue: https://github.com/microsoft/azure-devops-python-api/issues/349

symplrdudley avatar May 09 '23 14:05 symplrdudley