Skip to content

Commit dd5dc77

Browse files
Differentiate comment grammar examples
1 parent 8691330 commit dd5dc77

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -589,14 +589,18 @@ Translations of the guide are available in the following languages:
589589
the comment.
590590
<sup>[[link](#comment-leading-spaces)]</sup>
591591

592-
* <a name="comment-spacing"></a>
593-
Comments longer than a word are capitalized and use punctuation.
592+
* <a name="comment-grammar"></a>
593+
Comments longer than a word are capitalized, and sentences use punctuation.
594594
Use [one space][Sentence Spacing] after periods.
595-
<sup>[[link](#comment-spacing)]</sup>
595+
<sup>[[link](#comment-grammar)]</sup>
596596

597597
```elixir
598598
# not preferred
599-
String.upcase(some_string) # Capitalize string.
599+
# these lowercase comments are missing punctuation
600+
601+
# preferred
602+
# Capitalization example
603+
# Use punctuation for complete sentences.
600604
```
601605

602606
#### Comment Annotations

0 commit comments

Comments
 (0)