Skip to content

Summary docstrings should end with a period and be defined in one line #17

@jorgepiloto

Description

@jorgepiloto

🐞 Problem
The following rules apply for Python docstrings using Numpydoc style:

  • The first line of a docstring is used as a summary of the method.
  • The docstring must end with a period.

It may be possible that after generating the Python files, some docstrings exceed the maximum line length. It may be interesting to investigate if there is a way to set as a summary the first sentence and the rest of the docstring as a long description.

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