Skip to content

docstrings are inconsistent making Sphinx documentation not display properly #459

@symplrdudley

Description

@symplrdudley

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:

image

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:

image

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

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions