Skip to content

Code documentation - #19

Merged
sfluegel05 merged 7 commits into
devfrom
code_documentation
Apr 2, 2024
Merged

sfluegel05 merged 7 commits into
devfrom
code_documentation

Conversation

@VenkateshDas

Copy link
Copy Markdown
Collaborator

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

  • chebai/models/base.py
  • chebai/models/electra.py
  • chebai/preprocessing/datasets/base.py
  • chebai/preprocessing/datasets/chebi.py

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.]
"""

@VenkateshDas
VenkateshDas requested a review from sfluegel05 March 29, 2024 15:19
@sfluegel05
sfluegel05 merged commit c06b058 into dev Apr 2, 2024
@sfluegel05
sfluegel05 deleted the code_documentation branch April 2, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants