Skip to content

docs: The docstring summary is sometimes not separated from attributes, args, examples, ... #5032

Closed
@jloehel

Description

@jloehel

I am seeing some difficulties to render some docstrings with sphinx autodoc with the napoleon ext. In example the docstring from:

"""Get CVEs against a specific version of a product.
Example:
nvd.get_cves('haxx', 'curl', '7.34.0')
"""

It gets rendered to:

Image

The example gets not rendered correctly because there is no blank line between the summary and the example. If I add it, it gets rendered correctly.

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation changesgood first issueGood for newcomersgsocTasks related to our participation in Google Summer of Code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions