Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docstrings are inconsistent making Sphinx documentation not display properly #459

Open
symplrdudley opened this issue May 1, 2023 · 1 comment

Comments

@symplrdudley
Copy link

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
"""

@symplrdudley
Copy link
Author

Related to issue: #349

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant