ChEB-AI / python-chebai

GNU Affero General Public License v3.0
11 stars 4 forks source link

Code documentation #19

Closed VenkateshDas closed 5 months ago

VenkateshDas commented 5 months ago

Added docstrings to certain classes and functions in the following files:

The code documentation is in the following template:

"""
[One-line summary of the module/class/function's purpose]

Args:
    * [arg_name] ([type]): [Description of the argument.]
    * [arg_name] ([type]): [Description of the argument.]
        ... 

Attributes: 
    * [ATTRIBUTE_NAME] ([type]): [Description of the attribute]

Returns:
    [type]: [Description of the return value.]
"""