Enable pydocstring and fix all the issues

[dalonsoa]

Docstrings are not up to the appropriate standard - to start with, many are just missing. We implement QA in #32 , but we have disabled pydocstyle simply because of the many issues to fix.

It will take a significant amount of time to sort all of those, so it will need to be done bit by bit, enabling linting the docs (see pyproject.toml), see what fails, picking an error code to fix and disabling the others. And so on and so forth until all doc-related codes are enabled.

[dalonsoa]

@barneydobson , I'm going to leave this one to you. Not urgent but necessary to bring WSIMOD up to the appropriate standards - specially given that the documentation is built out of the docstrings.

Back implementing this is a pain, so let's make sure future code (in this repo or another) follow the standards from the onset - in principle, Google Style Docstrings. Happy to have a chat on this.

[barneydobson]

@dalonsoa thanks - how do I run the linting to see what needs fixing?

[dalonsoa]

I hope to update the contributing guidelines today precisely explaining how to do that. But all comes down to installing the dev dependencies with pip install -r requirements-dev.txtand then run ruff . (mind the period!).

If you run this, you should get no errors as we are not checking the docstrings. To get the errors, you will need to add "D" to this line:

wsi/pyproject.toml

Line 62 in bb247d6

select = ["E", "F", "I"] # pycodestyle, Pyflakes, isort. Ignoring pydocstyle (D), for now

As usual, used a separate branch to work on this.

Happy to have a chat tomorrow (before 10:30) if you want to go through this together.

[barneydobson]

great - I will have a play and let you know