Skip to content

Commit 446d19f

Browse files
yakryderbbatsov
authored andcommitted
Docstring grammar typos and changes (bbatsov#186)
This fixes two typos within the docstring grammar block and an error in conventional usage of the word ‘comprise’. It also arguably improves the flow of this section.
1 parent f648bd8 commit 446d19f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1982,22 +1982,21 @@ can identify them.
19821982

19831983
=== Docstring Grammar [[docstring-grammar]]
19841984

1985-
Docstrings should be comprised from
1986-
proper English sentences - this means every sentences should start
1987-
with an capitalized word and should end with the proper punctuation. Sentences
1988-
should be separated with a single space.
1985+
Docstrings should be composed of well-formed English sentences. Every sentence
1986+
should start with a capitalized word, be gramatically coherent, and end
1987+
with appropriate punctuation. Sentences should be separated with a single space.
19891988

19901989
[source,clojure]
19911990
----
19921991
;; good
19931992
(def foo
19941993
"All sentences should end with a period (or maybe an exclamation mark).
1995-
And the period should be followed by a space, unless it's the last sentence.")
1994+
The sentence should be followed by a space, unless it concludes the docstring.")
19961995
19971996
;; bad
19981997
(def foo
19991998
"all sentences should end with a period (or maybe an exclamation mark).
2000-
And the period should be followed by a space, unless it's the last sentence")
1999+
The sentence should be followed by a space, unless it concludes the docstring.")
20012000
----
20022001

20032002
=== Docstring Indentation [[docstring-indentation]]

0 commit comments

Comments
 (0)