[Enhancement] Achieve full docstring coverage

[DrShushen]

[Enhancement] Achieve full docstring coverage

[Rhobar9]

Can I take this issue?

[DrShushen]

Please feel free to do so, but I would recommend waiting until PR #64 is merged (in the next day or two), as that has a couple of changes to docstrings

[Rhobar9]

Thank you for advice:) I will immediately start the task after PR.

[DrShushen]

@Rhobar9

Please feel free to get started. Many thanks for taking this on!

Please read the following before contributing:

• Contributing guide: https://temporai.readthedocs.io/en/latest/contributing.html
• Developer's guide: https://temporai.readthedocs.io/en/latest/dev_guide.html

I would also recommend joining the slack - please join the #temporai channel so you can ask us any questions and get answers quickly.

Below is some info specifically for this task.

---

Overview:

• We use Google-style docstrings.
• Sphinx cross-referencing of python objects can be useful for this task.

I recommend using pydocstyle as follows:

• After you install the library with the dev extra in editable mode (pip install -e .[dev]), do pip install pydocstyle.
• You can then just run the pydocstyle command in the repo root to see any documentation issues that need to be resolved.
• pydocstyle error codes can be found here.
• Please remove these lines: https://github.com/vanderschaarlab/temporai/blob/main/pyproject.toml#L55-L62. They currently suppress the pydocstyle D10* errors about missing documentation. Since we want to get to 100% docstring coverage, this will help you identify where docstrings are missing.
• You can then just address the pydocstyle issues reported.

To build documentation locally and check there are no warnings or errors introduced by your changes, run:

tox -e docs

See here for what this command does.
I recommend running this occasionally as you add docstrings to check everything works.
If you would like to use conda environments for tox, you can install pip install tox-conda first.

At the end of this, we can add a pydocstyle check to the pre-commit config, so that documentation is enforced going forward.

[DrShushen]

Yep, go ahead

[Rhobar9]

Thank you for whole bunch of advices:) I will start immediately. I only need 1-2 days for analyse all informations. Obviously I will join the slack. Can I create my own fork?
Best regards,