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

[DISCUSSION] Docstrings in codebase #2109

Open
valentynbez opened this issue Aug 27, 2023 · 1 comment
Open

[DISCUSSION] Docstrings in codebase #2109

valentynbez opened this issue Aug 27, 2023 · 1 comment

Comments

@valentynbez
Copy link

valentynbez commented Aug 27, 2023

For now, a lot of functions and classes remain without documentation. In order to understand their function, purpose and methods it's necessary to dig through a code of a few separate files.
Example: finding the exact function for calling SNV from BAM files made me go through 5 different files.

Adding verbosity to the code will help understand the internals and decrease the entry level for contributions.

@meren
Copy link
Member

meren commented Aug 28, 2023

I agree 100%.

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