You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
guidelines for libraries].footnote:[Those guidelines are meant to
48
48
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
50
50
currently reading.
51
51
52
52
ifdef::env-github[]
@@ -94,7 +94,7 @@ Clojure code in the wild was fairly uniform. We attribute this to
94
94
both the simplicity we already mentioned and to the fact that since day
95
95
1 Clojurists adopted many of the style conventions of other
96
96
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
98
98
the massive exercise in frustration that was the
99
99
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.]
@@ -677,7 +677,7 @@ Start every namespace with a comprehensive `ns` form, comprised of
677
677
678
678
=== Line Breaks in `ns` [[line-break-ns-declaration]]
679
679
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.
681
681
This facilitates sorting, readability, and cleaner diffs for dependency changes.
682
682
683
683
[source,clojure]
@@ -957,7 +957,7 @@ Use `lisp-case` for function and variable names.
957
957
Use `CapitalCase` for protocols, records, structs, and types. (Keep
958
958
acronyms like HTTP, RFC, XML uppercase.)
959
959
960
-
NOTE: `CapitalCase` is also known as `UpperCamelCase, `CapitalWords`
960
+
NOTE: `CapitalCase` is also known as `UpperCamelCase`, `CapitalWords`
961
961
and `PascalCase`.
962
962
963
963
=== Predicate Methods [[naming-predicates]]
@@ -2383,7 +2383,7 @@ TIP: You can also consider adding `:supersedes` metadata to the newer APIs, basi
2383
2383
2384
2384
From time to time you might want to point out some related vars/namespaces that the users of your library might be interested in.
2385
2385
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.
2387
2387
2388
2388
[source,clojure]
2389
2389
----
@@ -2402,7 +2402,7 @@ simpler and more explicit to use the `:see-also` metadata instead.
2402
2402
2403
2403
=== `:no-doc`
2404
2404
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.
2406
2406
When a var or a namespace has `:no-doc` metadata, it indicates to these tools that it should be excluded from generated API docs.
2407
2407
2408
2408
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
0 commit comments