Skip to content

Commit 3ca2cbf

Browse files
committed
Fix typos and grammar mistakes in the guide
Fix 12 issues: missing words, duplicated words, comma splices, subject-verb disagreement, and a missing backtick.
1 parent 667af93 commit 3ca2cbf

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ programmers. A style guide that reflects real-world usage gets used, and a
2626
style guide that holds to an ideal that has been rejected by the people it is
2727
supposed to help risks not getting used at all -- no matter how good it is.
2828

29-
The guide is separated into several sections of related rules. we've
29+
The guide is separated into several sections of related rules. We've
3030
tried to add the rationale behind the rules (if it's omitted, we've
3131
assumed that it's pretty obvious).
3232

@@ -46,7 +46,7 @@ NOTE: Clojure's developers also maintain a list of
4646
https://clojure.org/community/contrib_howto#_coding_guidelines[coding
4747
guidelines for libraries].footnote:[Those guidelines are meant to
4848
be applied to Clojure itself and to all the Clojure Contrib libraries.]
49-
They were one of the sources of inspiration for the document, you're
49+
They were one of the sources of inspiration for the document you're
5050
currently reading.
5151

5252
ifdef::env-github[]
@@ -94,7 +94,7 @@ Clojure code in the wild was fairly uniform. We attribute this to
9494
both the simplicity we already mentioned and to the fact that since day
9595
1 Clojurists adopted many of the style conventions of other
9696
established Lisp dialects (e.g. Common Lisp and Scheme). This made
97-
the work on this guide fairly easy and straight-forward, especially compared to
97+
the work on this guide fairly easy and straightforward, especially compared to
9898
the massive exercise in frustration that was the
9999
https://rubystyle.guide[Community Ruby Style Guide].footnote:[You'll notice that the Clojure style guide is pretty similar in structure to the Ruby style guide, which served as its main source of inspiration. You'll also notice that the Ruby style guide is much longer, mostly because of the complexity of the Ruby language.]
100100

@@ -435,7 +435,7 @@ $ git config --global core.autocrlf true
435435

436436
End each file with a newline.
437437

438-
TIP: This should be done by through editor configuration, not manually.
438+
TIP: This should be done through editor configuration, not manually.
439439

440440
=== Bracket Spacing [[bracket-spacing]]
441441

@@ -655,7 +655,7 @@ or `library-name.core` for libraries with a single namespace in them.
655655
Read on for more coverage of the namespace naming topic.
656656

657657
There are https://github.com/bbatsov/clojure-style-guide/pull/100[other reasons]
658-
why might want to avoid single-segment namespaces, so you should
658+
why you might want to avoid single-segment namespaces, so you should
659659
think long and hard before making any use of them.
660660

661661
=== Namespace Segments Limit [[namespace-segments-limit]]
@@ -677,7 +677,7 @@ Start every namespace with a comprehensive `ns` form, comprised of
677677

678678
=== Line Breaks in `ns` [[line-break-ns-declaration]]
679679

680-
When there are multiple dependencies, you may want give each one its own line.
680+
When there are multiple dependencies, you may want to give each one its own line.
681681
This facilitates sorting, readability, and cleaner diffs for dependency changes.
682682

683683
[source,clojure]
@@ -957,7 +957,7 @@ Use `lisp-case` for function and variable names.
957957
Use `CapitalCase` for protocols, records, structs, and types. (Keep
958958
acronyms like HTTP, RFC, XML uppercase.)
959959

960-
NOTE: `CapitalCase` is also known as `UpperCamelCase, `CapitalWords`
960+
NOTE: `CapitalCase` is also known as `UpperCamelCase`, `CapitalWords`
961961
and `PascalCase`.
962962

963963
=== Predicate Methods [[naming-predicates]]
@@ -2383,7 +2383,7 @@ TIP: You can also consider adding `:supersedes` metadata to the newer APIs, basi
23832383

23842384
From time to time you might want to point out some related vars/namespaces that the users of your library might be interested in.
23852385
The most common way to do so would be via the `:see-also` metadata, which takes a vector of related items.
2386-
When talking about vars - items in the same namespace don't need to fully qualified.
2386+
When talking about vars - items in the same namespace don't need to be fully qualified.
23872387

23882388
[source,clojure]
23892389
----
@@ -2402,7 +2402,7 @@ simpler and more explicit to use the `:see-also` metadata instead.
24022402

24032403
=== `:no-doc`
24042404

2405-
Documentation tools like https://github.com/weavejester/codox#metadata-options[Codox] like https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#hiding-namespaces-vars-in-documentation[cljdoc] recognize `:no-doc` metadata.
2405+
Documentation tools like https://github.com/weavejester/codox#metadata-options[Codox] and https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#hiding-namespaces-vars-in-documentation[cljdoc] recognize `:no-doc` metadata.
24062406
When a var or a namespace has `:no-doc` metadata, it indicates to these tools that it should be excluded from generated API docs.
24072407

24082408
To exclude an entire namespace from API docs:
@@ -2846,7 +2846,7 @@ Important tools such as https://github.com/cljdoc/cljdoc/blob/master/doc/usergui
28462846

28472847
=== Document Positional Arguments [[document-pos-arguments]]
28482848

2849-
Document all positional arguments, and wrap them them with backticks
2849+
Document all positional arguments, and wrap them with backticks
28502850
(`) so that editors and IDEs can identify them and potentially provide extra
28512851
functionality for them.
28522852

@@ -3072,8 +3072,8 @@ One problem with style guides is that it's often hard to remember all the guidel
30723072
and to apply them consistently. We're only humans, after all. Fortunately,
30733073
there are a bunch of tools that can do most of the work for us.
30743074

3075-
TIP: It's a great idea run such tools as part of your continuous integration (CI).
3076-
This ensure that all the code in one project is consistent with the style you're
3075+
TIP: It's a great idea to run such tools as part of your continuous integration (CI).
3076+
This ensures that all the code in one project is consistent with the style you're
30773077
aiming for.
30783078

30793079
=== Lint Tools

0 commit comments

Comments
 (0)