Type hints, docstrings, comments

[eantonini]

Detailed Description

The Atlite codebase currently lacks consistent use of type hints and docstrings.

Adding these would improve code clarity and maintainability. Additional inline comments are also encouraged, even if the code may seem self-explanatory.

Context

Improving documentation and type safety will make Atlite more accessible and reduce the entry barrier for new contributors.

Possible Implementation

Introduce type hints and docstrings throughout the codebase, following standard Python conventions.

Enforce these standards using pre-commit hooks (e.g., via ruff) to ensure consistency in future contributions.

[lkstrp]

Thanks @eantonini !
Before we have type hints, we wanna have proper static typing, so I added another issue for it here: #472

As a linter, we want to use Ruff with the default settings first, and then, at some point, be as strict as here.