Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete docstrings #50

Merged
merged 92 commits into from
Sep 25, 2023
Merged

Complete docstrings #50

merged 92 commits into from
Sep 25, 2023

Conversation

marjanalbooyeh
Copy link
Collaborator

@marjanalbooyeh marjanalbooyeh commented Sep 18, 2023

The goal of this PR is to complete all the docstring required for readthedocs.

Note: I added a new githook to our pre-commit config that makes sure docstrings follow the numpy format. It could be a little annoying sometimes with too many errors but I think it's helpful for now, just to make sure we're not missing any docstring.

@codecov
Copy link

codecov bot commented Sep 19, 2023

Codecov Report

Merging #50 (102018d) into main (5c47cc4) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   93.63%   93.63%           
=======================================
  Files          18       18           
  Lines        1382     1383    +1     
=======================================
+ Hits         1294     1295    +1     
  Misses         88       88           
Files Coverage Δ
hoomd_organics/__init__.py 100.00% <ø> (ø)
hoomd_organics/base/__init__.py 100.00% <ø> (ø)
hoomd_organics/base/molecule.py 96.62% <100.00%> (ø)
hoomd_organics/base/simulation.py 91.26% <ø> (ø)
hoomd_organics/base/system.py 89.49% <100.00%> (ø)
hoomd_organics/library/__init__.py 100.00% <ø> (ø)
hoomd_organics/library/forcefields.py 100.00% <ø> (ø)
hoomd_organics/library/polymers.py 97.33% <ø> (ø)
hoomd_organics/library/simulations/tensile.py 100.00% <100.00%> (ø)
hoomd_organics/modules/__init__.py 100.00% <ø> (ø)
... and 3 more

Copy link
Member

@chrisjonesBSU chrisjonesBSU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an awesome start! I left a few suggestions. I'll keep checking back to review, and add in some of my own.

hoomd_organics/base/molecule.py Outdated Show resolved Hide resolved
hoomd_organics/base/molecule.py Outdated Show resolved Hide resolved
hoomd_organics/base/molecule.py Outdated Show resolved Hide resolved
hoomd_organics/base/molecule.py Show resolved Hide resolved
hoomd_organics/base/simulation.py Outdated Show resolved Hide resolved
hoomd_organics/base/simulation.py Outdated Show resolved Hide resolved
hoomd_organics/base/simulation.py Show resolved Hide resolved
hoomd_organics/base/simulation.py Show resolved Hide resolved
hoomd_organics/base/system.py Show resolved Hide resolved
hoomd_organics/base/system.py Outdated Show resolved Hide resolved
@marjanalbooyeh marjanalbooyeh linked an issue Sep 21, 2023 that may be closed by this pull request
@marjanalbooyeh marjanalbooyeh merged commit d71f21e into cmelab:main Sep 25, 2023
3 checks passed
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.

Finish doc strings
3 participants