Skip to content

Code documentation - #35

Merged
sfluegel05 merged 20 commits into
devfrom
code_documentation
Jul 8, 2024
Merged

sfluegel05 merged 20 commits into
devfrom
code_documentation

Conversation

@aditya0by0

Copy link
Copy Markdown
Member

Tasks

  • Annotate code with docstrings for relevant classes/code in the repository
  • Add Type Hints for relevant classes/code in the repository

- All relevant file updated with docstring and type hints except datasets/chebi.py
- chebi.py not modified due to dependency with PR#29 Issue#10
- it will be updated after the above PR gets merged
- Updated all tests with docstring and type hints except tests related to chebi data due to dependency with PR#29  Issue#10
- Chebi tests will be updated after the above PR gets merged
@aditya0by0

aditya0by0 commented Jun 26, 2024 •

Copy link
Copy Markdown
Member Author
  • datasets/chebi.py
  • 2 Test Classes related to chebi data

Also, the PR #29 has been re-formated with new pre-commit, so I think this PR should be merged after the PR #29, with potential conflicts reolved

@aditya0by0 aditya0by0 linked an issue Jun 26, 2024 that may be closed by this pull request
Comment thread chebai/cli.py Resolved
@aditya0by0

Copy link
Copy Markdown
Member Author
  • datasets/chebi.py
  • 2 Test Classes related to chebi data

Also, the PR #29 has been re-formated with new pre-commit, so I think this PR should be merged after the PR #29, with potential conflicts reolved

Hi @sfluegel05, I have resolved the conflicts and updated the mentioned files with docstrings and type hints. Please review.

@sfluegel05
sfluegel05 marked this pull request as ready for review July 8, 2024 15:14
@sfluegel05

Copy link
Copy Markdown
Collaborator

Thanks, that is a really comprehensive documentation. We will profit from that for a long time.

@sfluegel05
sfluegel05 merged commit bdda7ee into dev Jul 8, 2024
@sfluegel05
sfluegel05 deleted the code_documentation branch July 8, 2024 15:19
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.

Code needs to be documented

2 participants