search

datasets / covid-19

Novel Coronavirus 2019 time series data on cases
https://datahub.io/core/covid-19
1.16k stars 604 forks source link

Update process.py #89

Closed rchurt closed 4 years ago

rchurt commented 4 years ago

added comments to help users like me who skipped the readme and came straight here

sglavoie commented 4 years ago

FIXED: Closing as the PR will not be merged. The commit title and description are also lacking important information: exploring the git log will tell us already which file is being modified and there is no description of the change being made that can be seen in the commit description itself without having to read the code first.

rchurt commented 4 years ago

@sglavoie I must say, this is one of the least helpful responses I've received to a commit that I've made.

I was attempting to improve the grossly inadequate internal documentation in this script. You yourself say that "function comments should be located inside functions"—you have made no attempt to do this for any of the functions in the script. The purpose of each function is of course not documented anywhere else, so I assume that you expect users to figure out how your code works just by reading it, which I would hope you know is bad programming practice.

Instead of realizing that the purpose of my contribution was to improve the documentation and taking it upon yourself to improve it as you saw fit if you didn't agree with my method, you tried to find any excuse to avoid adding comments. So the script remains as poorly commented as it was before.

It's fine to disagree with the way a user phrased his/her contribution, but if you expect them to keep contributing, you need to work with them, not against them. I truly hope this is helpful, and that you consider reevaluating how you value and therefore treat contributors to your projects.

sglavoie commented 4 years ago