Codebase Clean-up
The codebase currently still contains a lot of code that
- is dead (from a failed experiment or not needed anymore, also all the code in the
examples
directory which looks like someones personal experiment scratchpad) - is duplicated (snippets that appear similarly in multiple places)
- has incorrect or not up-to-date documentation (copy-pasted docstrings, or missing/changed parameters, etc)
All of that should be cleaned up.
- Dead code in the package should be removed (unremoved code = needs maintenance)
- Examples in
examples
should be made either into proper part of the package, or also removed - For docstrings, a linter should be used to check the consistency (and buggy docstrings should be fixed). Better to have no docstring than have an absolutely useless one.
- Typehints should be added wherever possible (without causing too much pain / acrobatics)