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

Add documentation #3

Open
2 tasks
ScottWales opened this issue Aug 10, 2021 · 1 comment
Open
2 tasks

Add documentation #3

ScottWales opened this issue Aug 10, 2021 · 1 comment

Comments

@ScottWales
Copy link

ScottWales commented Aug 10, 2021

Since there's only a few functions, probably no need to use readthedocs or anything

  • Convert the function comments to docstrings
  • Describe the intended workflow in the readme file
@aidanheerdegen
Copy link
Member

  • Add scientific reference for method to README

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

No branches or pull requests

2 participants