merenlab / anvio

An analysis and visualization platform for 'omics data
http://merenlab.org/software/anvio
GNU General Public License v3.0
423 stars 144 forks source link

[DISCUSSION] Docstrings in codebase #2109

Open valentynbez opened 1 year ago

valentynbez commented 1 year ago

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 commented 1 year ago

I agree 100%.