Skip to content

Add comments with inline documentation  #27

Open
@jorinvo

Description

@jorinvo

We tried writing the code as simple, modular and straight-forward as possible, but it would be still better to have some explanation about what certain modules and functions do.
I think it wouldn't even be necessary to just an official documentation style and document every parameter.
I'm more thinking about having some introduction at the to of each file. It should be simpler for new contributors to see what the different parts of the project do.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions