Skip to content

Commit e6cb6da

Browse files
committed
Tweak a couple of headings
1 parent 75644d0 commit e6cb6da

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ https://rubystyle.guide[Community Ruby Style Guide].footnote:[You'll notice that
102102
Clojure is famously optimized for simplicity and clarity. I'd like to believe that this guide is going to help you optimize for maximum
103103
simplicity and clarity.
104104

105-
=== A Note about Consistency
105+
=== A Note About Consistency
106106

107107
[quote, Ralph Waldo Emerson]
108108
____
@@ -416,7 +416,7 @@ $ git config --global core.autocrlf true
416416
----
417417
====
418418

419-
=== Terminate Files with a Newline [[terminate-files-with-a-newline]]
419+
=== Terminate Files With a Newline [[terminate-files-with-a-newline]]
420420

421421
End each file with a newline.
422422

@@ -460,7 +460,7 @@ Don't use commas between the elements of sequential collection literals.
460460
(1, 2, 3)
461461
----
462462

463-
=== Optional Commas In Map Literals [[opt-commas-in-map-literals]]
463+
=== Optional Commas in Map Literals [[opt-commas-in-map-literals]]
464464

465465
Consider enhancing the readability of map literals via judicious use
466466
of commas and line breaks.
@@ -494,7 +494,7 @@ Place all trailing parentheses on a single line instead of distinct lines.
494494
)
495495
----
496496

497-
=== Empty Lines Between Top Level Forms [[empty-lines-between-top-level-forms]]
497+
=== Empty Lines Between Top-Level Forms [[empty-lines-between-top-level-forms]]
498498

499499
Use a single empty line between top-level forms.
500500

@@ -575,7 +575,7 @@ too much and could potentially be broken down.
575575

576576
Avoid trailing whitespace.
577577

578-
=== One File Per Namespace [[one-file-per-namespace]]
578+
=== One File per Namespace [[one-file-per-namespace]]
579579

580580
Use one file per namespace and one namespace per file.
581581

@@ -704,7 +704,8 @@ considered deprecated for new code.
704704
(:use clojure.zip))
705705
----
706706

707-
=== Sort requirements and imports [[sort-requirements-and-imports]]
707+
=== Sort Requirements and Imports [[sort-requirements-and-imports]]
708+
708709
In the `ns` form, sort your requirements and imports. This facilitates readability and avoids duplication, especially when the list of required / imported namespaces is very long.
709710

710711
[source,clojure]
@@ -891,7 +892,7 @@ Use `lisp-case` for function and variable names.
891892
(def some_fun ...)
892893
----
893894

894-
=== Protocols, Records, Structs And Types [[naming-protocols-records-structs-and-types]]
895+
=== Protocols, Records, Structs and Types [[naming-protocols-records-structs-and-types]]
895896

896897
Use `CapitalCase` for protocols, records, structs, and types. (Keep
897898
acronyms like HTTP, RFC, XML uppercase.)
@@ -1081,7 +1082,7 @@ function name.
10811082
(baz x))
10821083
----
10831084

1084-
=== Oneline Short Function [[oneline-short-fn]]
1085+
=== One-line Functions
10851086

10861087
Optionally omit the new line between the argument vector and a short
10871088
function body.
@@ -2605,7 +2606,7 @@ lines should be indented as much as the first one.
26052606
(baz))
26062607
----
26072608

2608-
==== Sign And Date Annotations [[sign-and-date-annotations]]
2609+
==== Sign and Date Annotations [[sign-and-date-annotations]]
26092610

26102611
Tag the annotation with your initials and a date so its relevance can
26112612
be easily verified.

0 commit comments

Comments
 (0)