Skip to content

Commit 497dbc0

Browse files
Nondvbbatsov
authored andcommitted
Fix comments in documentation section (bbatsov#158)
1 parent 8155b73 commit 497dbc0

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1596,7 +1596,7 @@ practices for documenting Clojure code.
15961596
<sup>[[link](#prefer-docstrings)]</sup>
15971597
15981598
```clojure
1599-
# good
1599+
;; good
16001600
(defn foo
16011601
"This function doesn't do much."
16021602
[]
@@ -1605,7 +1605,7 @@ practices for documenting Clojure code.
16051605
(ns foo.bar.core
16061606
"That's an awesome library.")
16071607
1608-
# bad
1608+
;; bad
16091609
(defn foo
16101610
^{:doc "This function doesn't do much."}
16111611
[]
@@ -1623,15 +1623,15 @@ the docstring at various places.
16231623
<sup>[[link](#docstring-summary)]</sup>
16241624
16251625
```clojure
1626-
# good
1626+
;; good
16271627
(defn frobnitz
16281628
"This function does a frobnitz.
16291629
It will do gnorwatz to achieve this, but only under certain
16301630
cricumstances."
16311631
[]
16321632
...)
16331633
1634-
# bad
1634+
;; bad
16351635
(defn frobnitz
16361636
"This function does a frobnitz. It will do gnorwatz to
16371637
achieve this, but only under certain cricumstances."
@@ -1646,14 +1646,14 @@ functionality for them.
16461646
<sup>[[link](#document-pos-arguments)]</sup>
16471647
16481648
```clojure
1649-
# good
1649+
;; good
16501650
(defn watsitz
16511651
"Watsitz takes a `frob` and converts it to a znoot.
16521652
When the `frob` is negative, the znoot becomes angry."
16531653
[frob]
16541654
...)
16551655
1656-
# bad
1656+
;; bad
16571657
(defn watsitz
16581658
"Watsitz takes a frob and converts it to a znoot.
16591659
When the frob is negative, the znoot becomes angry."
@@ -1667,14 +1667,14 @@ can identify them.
16671667
<sup>[[link](#document-references)]</sup>
16681668
16691669
```clojure
1670-
# good
1670+
;; good
16711671
(defn wombat
16721672
"Acts much like `clojure.core/identity` except when it doesn't.
16731673
Takes `x` as an argument and returns that. If it feels like it."
16741674
[x]
16751675
...)
16761676
1677-
# bad
1677+
;; bad
16781678
(defn wombat
16791679
"Acts much like clojure.core/identity except when it doesn't.
16801680
Takes `x` as an argument and returns that. If it feels like it."
@@ -1689,12 +1689,12 @@ should be separated with a single space.
16891689
<sup>[[link](#docstring-grammar)]</sup>
16901690
16911691
```clojure
1692-
# good
1692+
;; good
16931693
(def foo
16941694
"All sentences should end with a period (or maybe an exclamation mark).
16951695
And the period should be followed by a space, unless it's the last sentence.")
16961696
1697-
# bad
1697+
;; bad
16981698
(def foo
16991699
"all sentences should end with a period (or maybe an exclamation mark).
17001700
And the period should be followed by a space, unless it's the last sentence")
@@ -1705,14 +1705,14 @@ Indent multi-line docstrings by two spaces.
17051705
<sup>[[link](#docstring-indentation)]</sup>
17061706
17071707
```clojure
1708-
# good
1708+
;; good
17091709
(ns my.ns
17101710
"It is actually possible to document a ns.
17111711
It's a nice place to describe the purpose of the namespace and maybe even
17121712
the overall conventions used. Note how _not_ indenting the doc string makes
17131713
it easier for tooling to display it correctly.")
17141714
1715-
# bad
1715+
;; bad
17161716
(ns my.ns
17171717
"It is actually possible to document a ns.
17181718
It's a nice place to describe the purpose of the namespace and maybe even
@@ -1725,12 +1725,12 @@ Neither start nor end your doc strings with any whitespace.
17251725
<sup>[[link](#docstring-leading-trailing-whitespace)]</sup>
17261726
17271727
```clojure
1728-
# good
1728+
;; good
17291729
(def foo
17301730
"I'm so awesome."
17311731
42)
17321732
1733-
# bad
1733+
;; bad
17341734
(def silly
17351735
" It's just silly to start a doc string with spaces.
17361736
Just as silly as it is to end it with a bunch of them. "

0 commit comments

Comments
 (0)