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

DOC: add proper documentation #26

Open
vkhodygo opened this issue Apr 21, 2021 · 0 comments
Open

DOC: add proper documentation #26

vkhodygo opened this issue Apr 21, 2021 · 0 comments
Assignees
Labels
doc Documentation

Comments

@vkhodygo
Copy link
Contributor

  • There is a giant docstring that goes before all imports, that looks like a feature of CellProfiler;
  • Functions are poorly documented;
  • Comments mark logical blocks that can be moved to separate functions (see MAINT: split functions #25)
@vkhodygo vkhodygo added the doc Documentation label Apr 21, 2021
@vkhodygo vkhodygo self-assigned this Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

No branches or pull requests

1 participant