Skip to content

Minor word fixes & typos for Book of Clerk #487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
May 17, 2023
Merged

Minor word fixes & typos for Book of Clerk #487

Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
eda134e
fix typo: "conv(en)ience"
daveliepmann May 16, 2023
bdb2649
fix dangling "either"
daveliepmann May 16, 2023
0611452
fix typo: double "is"
daveliepmann May 16, 2023
ee39515
fix typo: exten(t/s)ion
daveliepmann May 16, 2023
e64a4d7
fix words
daveliepmann May 16, 2023
0a3d270
spelling & comma
daveliepmann May 16, 2023
e0316f3
code span
daveliepmann May 17, 2023
c860b27
pluralize
daveliepmann May 17, 2023
493c870
wrong word
daveliepmann May 17, 2023
5a17660
missing word
daveliepmann May 17, 2023
0c12a56
punctuation for end of sentence
daveliepmann May 17, 2023
b77de00
bump total # of viewers
daveliepmann May 17, 2023
71b07f8
words
daveliepmann May 17, 2023
4abe23c
better word
daveliepmann May 17, 2023
78c00be
spelling
daveliepmann May 17, 2023
cbd2009
fix words
daveliepmann May 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions book.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
;; cd clerk-demo
;; ```

;; Then open `dev/user.clj` from the project in your favorite editor start a REPL into the project, see
;; Then open `dev/user.clj` from the project in your favorite editor and start a REPL into the project. For editor-specific instructions see:
;; * [Emacs & Cider](https://docs.cider.mx/cider/basics/up_and_running.html#launch-an-nrepl-server-from-emacs)
;; * [Calva](https://calva.io/jack-in-guide/)
;; * [Cursive](https://cursive-ide.com/userguide/repl.html)
Expand All @@ -69,15 +69,15 @@
;; ;; start Clerk's built-in webserver on the default port 7777, opening the browser when done
;; (clerk/serve! {:browse? true})

;; ;; either call `clerk/show!` explicitly to show a given notebook.
;; ;; either call `clerk/show!` explicitly to show a given notebook, or use the File Watcher described below.
;; (clerk/show! "notebooks/rule_30.clj")
;; ```

;; You can then access Clerk at <http://localhost:7777>.

;; ### ⏱ File Watcher

;; You can load, evaluate, and present a file with the clerk/show! function, but in most cases it's easier to start a file watcher with something like:
;; You can load, evaluate, and present a file with the `clerk/show!` function, but in most cases it's easier to start a file watcher with something like:

;; ```clojure
;; (clerk/serve! {:watch-paths ["notebooks" "src"]})
Expand Down Expand Up @@ -183,8 +183,8 @@

;; Clerk provides a built-in data table viewer that supports the three
;; most common tabular data shapes out of the box: a sequence of maps,
;; where each map's keys are column names; a seq of seq, which is just
;; a grid of values with an optional header; a map of seqs, in with
;; where each map's keys are column names; a seq of seqs, which is just
;; a grid of values with an optional header; a map of seqs, in which
;; keys are column names and rows are the values for that column.

(clerk/table [[1 2]
Expand Down Expand Up @@ -246,7 +246,7 @@
;; You can provide a map of [embed options](https://github.com/vega/vega-embed#embed) to the vega viewer via the `:embed/opts` key.
;;
;; Clerk handles conversion from EDN to JSON for you.
;; The official Vega-Lite examples are in JSON, but a Clojure/EDN version available:
;; The official Vega-Lite examples are in JSON, but a Clojure/EDN version is available:
;; [Carsten Behring's Vega gallery in EDN](https://github.clerk.garden/behrica/vl-galery/).

;; ### 🎼 Code
Expand Down Expand Up @@ -303,7 +303,7 @@

;; ### 🔠 Grid Layouts

;; Layouts can be composed via `row`s and `col`s
;; Layouts can be composed via `row`s and `col`s.
;;
;; Passing `:width`, `:height` or any other style attributes to
;; `::clerk/opts` will assign them on the row or col that contains
Expand Down Expand Up @@ -404,7 +404,7 @@

;; **Metadata Notation**

;; In the examples above, we've used convience helper functions like
;; In the examples above, we've used convenience helper functions like
;; `clerk/html` or `clerk/plotly` to wrap values in a viewer. If you
;; call this on the REPL, you'll notice a given value gets wrapped in
;; a map under the `:nextjournal/value` key with the viewer being in
Expand Down Expand Up @@ -443,7 +443,7 @@ v/default-viewers

(assoc (frequencies (mapcat keys v/default-viewers)) :total (count v/default-viewers))

;; We have a total of 41 viewers in the defaults. Let's start with a
;; We have a total of 43 viewers in the defaults. Let's start with a
;; simple example and explain the different extensions points in the
;; viewer api.

Expand Down Expand Up @@ -471,7 +471,7 @@ v/default-viewers
^{::clerk/viewer show-raw-value}
(v/present 1)

;; This data structure is is sent over Clerk's websocket to the
;; This data structure is sent over Clerk's websocket to the
;; browser, where it will be displayed using the `:render-fn` found in
;; the `:nextjournal/viewer` key.

Expand Down Expand Up @@ -503,7 +503,7 @@ v/default-viewers

;; #### ⚙️ Transform

;; When writing your own viewer, the first extention point you should reach for is `:tranform-fn`.
;; When writing your own viewer, the first extension point you should reach for is `:tranform-fn`.

#_ "exercise: wrap this in `v/present` and call it at the REPL"
(v/with-viewer {:transform-fn #(clerk/html [:pre (pr-str %)])}
Expand Down Expand Up @@ -588,8 +588,8 @@ v/table-viewer
;; representations and let the user switch between them in the
;; browser.

;; We start with a simple function that takes a such an expression and
;; turns it into a map with two representation, one TeX and the
;; We start with a simple function that takes such an expression and
;; turns it into a map with two representations, one TeX and the
;; original form.

(defn transform-literal [expr]
Expand All @@ -600,7 +600,7 @@ v/table-viewer
;; also calls `clerk/mark-preserve-keys`. This tells Clerk to leave
;; the keys of the map as-is.

;; In our `:render-fn`, which is called in the browser we will recieve
;; In our `:render-fn`, which is called in the browser, we will receive
;; this map. Note that this is a quoted form, not a function. Clerk
;; will send this form to the browser for evaluation. There it will
;; create a `reagent/atom` that holds the selection state. Lastly,
Expand Down Expand Up @@ -703,10 +703,10 @@ v/table-viewer

;; #### 👷 Loading Libraries

;; This is a custom viewer for
;; Here is a custom viewer for
;; [Mermaid](https://mermaid-js.github.io/mermaid), a markdown-like
;; syntax for creating diagrams from text. Note that this library
;; isn't bundles with Clerk but we use a component based on
;; isn't bundled with Clerk but we use a component based on
;; [d3-require](https://github.com/d3/d3-require) to load it at
;; runtime.

Expand Down Expand Up @@ -742,7 +742,7 @@ v/table-viewer

;; ### 🙈 Visibility

;; By default, Clerk will always show code and
;; By default, Clerk will show all code and
;; results for a notebook.

;; You can use a map of the following shape to set the visibility of
Expand Down Expand Up @@ -860,7 +860,7 @@ rows
;; function. You can pass it a set of notebooks via the `:paths`
;; option (also supporting glob patterns).

;; When Clerk is building multuple notebooks, it will automatically
;; When Clerk is building multiple notebooks, it will automatically
;; generate an index page that will be the first to show up when
;; opening the build. You can override this index page via the
;; `:index` option.
Expand Down