Skip to content

provide better docstring support for the components #467

Closed
@T4rk1n

Description

@T4rk1n

A few issue with the components docstring.

  • When working in vscode, the components docstring doesn't get applied because there is a filename with the same name as the component name. Solution: use snake_case for the component classes filename.
  • The arguments docstring is not in the right place, it should be under init.
  • Add type hinting with the typing module (can be used in python 2 docstrings).
  • docstring max width should be max 70 chars.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3backlogfeaturesomething new

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions