Skip to content

Add and document a good way to render parameter documentation #23

@adamtheturtle

Description

@adamtheturtle

Thank you for this package 🙏

There are a few major ways to write Python docstrings, the default rST way:

:param path: The path of the file to wrap
:type path: str

/Users/adam/Desktop/Autobazel screenshot.png
and the Google way:

Args:
    path (str): The path of the file to wrap

The Google way is supported using sphinx.ext.napoleon.

The documentation in this package's examples is a mix of both, and not rendered nicely.
I have attached a screenshot of this package's documentation.
In particular, the word "Args" shows as inline in the docstring and the word "Param" is capitalised and rendered.

Autobazel screenshot

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions