search

neherlab / covid19_scenarios

Models of COVID-19 outbreak trajectories and hospital demand
https://covid19-scenarios.org
MIT License
1.36k stars 354 forks source link

Adding comments for better understanding of code #685

Closed sravanroy closed 4 years ago

sravanroy commented 4 years ago

My first contribution to this project and looking forward to making more useful contributions in the future!

vercel[bot] commented 4 years ago

This pull request is being automatically deployed with Vercel (learn more). To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/covid19-scenarios/covid19-scenarios/4ycc5g9ma ✅ Preview: https://covid19-scenarios-git-fork-sravanroy-patch-1.covid19-scenarios.now.sh

codeclimate[bot] commented 4 years ago

Code Climate has analyzed commit e9499800 and detected 0 issues on this pull request.

View more on Code Climate.

ivan-aksamentov commented 4 years ago

@sravanroy Hi Sravan!

Thanks, but, honestly, I don't see much value in these comments. They are just stating the obvious facts, trivially deducible from the corresponding code fragment itself. The cost of reading the comment is the same as the cost of reading the code, so it's just a duplication. And duplication should be removed.

Also, this particular code is absolutely not important. This just a one-time converter/sorter script. I am not even sure if it's a part of the pipeline or whether it is used at all. The documentation efforts should be applied elsewhere.If you have time, you could take a look at case data parsers (raw-to-tsv) and converters (tsv-to-json). Parsers for sure, they can use some love.

sravanroy commented 4 years ago

Thanks for the feedback!