-
Notifications
You must be signed in to change notification settings - Fork 217
Open
Description
Related to Issue: #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:
azure-devops-python-api/azure-devops/azure/devops/v7_0/build/build_client.py
Lines 14 to 18 in b2d0009
| class BuildClient(Client): | |
| """Build | |
| :param str base_url: Service URL | |
| :param Authentication creds: Authenticated credentials. | |
| """ |
But the functional lines that display properly have space around the description, like:
| class AgentPoolQueue(Model): | |
| """ | |
| Represents a queue for running builds. | |
| :param _links: | |
| :type _links: :class:`ReferenceLinks <azure.devops.v7_0.build.models.ReferenceLinks>` | |
| :param id: The ID of the queue. | |
| :type id: int | |
| :param name: The name of the queue. | |
| :type name: str | |
| :param pool: The pool used by this queue. | |
| :type pool: :class:`TaskAgentPoolReference <azure.devops.v7_0.build.models.TaskAgentPoolReference>` | |
| :param url: The full http link to the resource. | |
| :type url: str | |
| """ |
Metadata
Metadata
Assignees
Labels
No labels

