try to aling with google style docstring
_Not a critical PR_
This PR is a suggestion to start aligning docstrings using Google-style docstring format (I saw most of our code uses this one so it will be easier to change all the occurrences).
See https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html and https://google.github.io/styleguide/pyguide.html for more information.
Please let me know what you think in regards to the following:
- Use of `Raises` instead of `Raises the following errors`
- Use of the notation `:obj:` for the data types in Args, Return, and Raises (See https://stackoverflow.com/questions/41127200/in-python-docstrings-what-does-obj-do for more information).
- Use of direct name of exception instead of full path e.g:`obj:`DatasetModuleNotInstalledError`` (I find this more readable)
try to aling with google style docstring: _Not a critical PR_
This PR is a suggestion to start aligning docstrings using Google-style docstring format (I saw most of our code uses this one so it will be easier to change all the occurrences).
See https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html and https://google.github.io/styleguide/pyguide.html for more information.
Please let me know what you think in regards to the following:
- Use of `Raises` instead of `Raises the following errors`
- Use of the notation `:obj:` for the data types in Args, Return, and Raises (See https://stackoverflow.com/questions/41127200/in-python-docstrings-what-does-obj-do for more information).
- Use of direct name of exception instead of full path e.g:`obj:`DatasetModuleNotInstalledError`` (I find this more readable)