That's not well-commented code, that's just noise. When you are calling a function named "read_csv()", you do not need to add a comment that says "Read the CSV file". These sorts of comments make code harder for humans to read.
The hill that I will die on is that if you need to comment what your code is doing, your code is either a) bad and should be rewritten to be clearer, or b) the result of tricky, clever optimization that you needed to do after profiling.
Comments should tell readers why you're doing something, when it's not obvious based on the code itself.
The hill that I will die on is that if you need to comment what your code is doing, your code is either a) bad and should be rewritten to be clearer, or b) the result of tricky, clever optimization that you needed to do after profiling.
Comments should tell readers why you're doing something, when it's not obvious based on the code itself.