Skip to content

Commit 1e07f85

Browse files
Remove guidelines on comments as they can be enforced by eslint rules
1 parent 2118231 commit 1e07f85

File tree

1 file changed

+0
-20
lines changed

1 file changed

+0
-20
lines changed

README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -173,26 +173,6 @@ export const apiKey = 'SOMEKEY'
173173
export const API_KEY = 'SOMEKEY'
174174
```
175175

176-
- Use `//` for single line comments and `/* */` for multi-line comments.
177-
178-
```javascript
179-
// bad
180-
181-
// This is a very long comment that continues on and goes over multiple lines,
182-
// saying something very long and detailed which all developers will appreciate
183-
// reading and thinking about.
184-
185-
/* This is just a single line comment. */
186-
187-
// good
188-
189-
/* This is a very long comment that continues on and goes over multiple lines,
190-
* saying something very long and detailed which all developers will appreciate
191-
* reading and thinking about. */
192-
193-
// This is just a single line comment.
194-
```
195-
196176
## Filenames
197177

198178
- Store source code in a subdirectory called `/src/`.

0 commit comments

Comments
 (0)