Docstrings and type hints corrections
All modules and functions in the besos packages should have complete docstrings and type hints.
Walkthrough each module within the besos/besos folder and ensure every function has a complete and well formatted docstring and type hint.
An example of a good docstring and type hint on a function is the following:
A template docstring is as follows:
"""
Description of the purpose of the function
:param NAMEOFPARAM1: Type the parameter and what it is
:param NAMEOFPARAM2: Type the parameter and what it is
:return: Type of return and what it is
"""
Ensure there is a empty line between the description and the parameters or else the automodule on readthedocs will display the following:
Edited by Peter Wilson