Skip to content

Commit ee6ae8b

Browse files
authored
Improve comments guidelines in CONTRIBUTING.md
Reorganize comments on code explanation for clarity.
1 parent 9ff9cfb commit ee6ae8b

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@ We want your work to be readable by others; therefore, we encourage you to note
140140
x += 2 # increased by 2
141141
```
142142

143-
This is too trivial. Comments should not merely repeat what the code already says. Comments should explain ___why___ we are doing things. Comments on the same line as code should never cause the line to wrap (> 88 characters per line). Comments which are not on the same line as code should appear ___before___ the code they describe. "First tell the reader ___why___ with comments and then show them ___how___ with code."
143+
This is too trivial. Comments should not merely repeat what the code already says. Comments should explain ___why___ we are doing things. Comments on the same line as code should never cause the line to wrap (> 88 characters per line).
144+
Comments which are not on the same line as code should appear ___before___ the code they describe. "First tell the reader ___why___ with comments and then show them ___how___ with code."
144145

145146
We require you to put docstrings inside your functions, but please pay attention to the indentation of docstrings. The following is a good example:
146147

0 commit comments

Comments
 (0)