Inline documentation in many different modules (such as the block modules or enum modules) are lacking full documentation.
All functions, methods and classes should be given docstrings
Docstrings should ideally mention what is returned if applicable, if no return what the function does, and have an explanation of
parameters if necessary (i.e. what are the units of the 'distance' parameter, etc).
Module files should have a brief description comment at the beginning of the file
All functions, methods and class attributes should be type annotated as specifically as possible
Doing so will not only make the code clearer for newcomers, but can also help with intelli-sense/LSP suggestions. This will speed up the development process and make errors less probable.
Inline documentation in many different modules (such as the block modules or enum modules) are lacking full documentation.
Doing so will not only make the code clearer for newcomers, but can also help with intelli-sense/LSP suggestions. This will speed up the development process and make errors less probable.