Skip to content

Commit 37b48dc

Browse files
committed
Remove comment rule from style guide
1 parent c4ae653 commit 37b48dc

File tree

1 file changed

+1
-12
lines changed

1 file changed

+1
-12
lines changed

STYLE-GUIDE.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,9 @@ purpose.
2525

2626
* Commas should have at least one space following them.
2727

28-
* Wherever possible, comments should precede the line/lines that
29-
it is explaining, ie.
30-
31-
```python
32-
some_var = 5 # Avoid this type of comment wherever possible
33-
34-
# This is preferrable
35-
some_other_var = 6
36-
```
37-
3828
* Please try to adhere to the 79-character line length limit.
3929
This makes it easier to have multiple terminals/text-editors open,
40-
without unnecessary line-wrapping. This is the rationale for the
41-
comment style as well.
30+
without unnecessary line-wrapping.
4231

4332
* Important variables should be named properly. Use snake case,
4433
ie. underscores as word separators. Do not use camelCase/PascalCase.

0 commit comments

Comments
 (0)