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

Cleaning up the codes #59

Closed
FanwangM opened this issue Apr 11, 2022 · 0 comments
Closed

Cleaning up the codes #59

FanwangM opened this issue Apr 11, 2022 · 0 comments
Labels
Milestone

Comments

@FanwangM
Copy link
Collaborator

For some parts of our package, the documentation is unclear. Can you help double check if the parts you are working on are missing such clear documentation and fix them?

  • We will also need to add the references if some equations or algorithms are taken from some papers. For an example putting references, you can take a look at https://numpydoc.readthedocs.io/en/latest/format.html.
  • Add Raises if there is any error checking
  • Type checking for all the functions or classes including inherited classes
  • Add more tests to increase coverage (add tests for missing lines)
  • Add some explanations of your equation or algorithms to Notes section. We will need to have equations explicitly expressed in the documentation.

If you can think of other things that we should use for cleaning the codes, please comment here. Thank you.
@alnaba1 @RichRick1 @Khaleeh @fwmeng88

@FanwangM FanwangM added the todo label May 14, 2022
@FarnazH FarnazH added this to the release milestone May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants