Skip to content

Essential docs for more comfort code navigation  #265

@donRumata03

Description

@donRumata03

It's a common practice to put short (only essential) docs in __init__.py files with general information what is the module responsible for.
That seems to be extremely useful for new contributors since it provides abstractions from authors' heads directly to docs while being pretty easy to create (only short docs are required).

Also, essential details of implementation of undocumented classes could be useful for the same reasons (full docs with listing all the parameters indeed seem redundant).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions