Skip to content

Syntax for optional parameters not correct #9

@timobrembeck

Description

@timobrembeck

In your tutorial, you suggest using , optional after the parameter type to denote that a parameter is optional.
However, according to the following sources, this is not the official syntax for sphinx/reStructuredText docstrings:

Moreover, Sphinx procudes a warning when used in nit-picky mode:

WARNING: py:class reference target not found: optional

Thus, I suggest removing this syntax from the tutorial. I'm sorry if I missed any important resources.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions