From eda134e0691029cde9eeafecbb3c53e37159a18f Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Tue, 16 May 2023 10:09:28 +0200 Subject: [PATCH 01/16] fix typo: "conv(en)ience" --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 466793a14..56f52383f 100644 --- a/book.clj +++ b/book.clj @@ -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 From bdb26491bf5cf4e63fb1c3a5645872f2244e3c16 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Tue, 16 May 2023 10:09:57 +0200 Subject: [PATCH 02/16] fix dangling "either" --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 56f52383f..3429218ef 100644 --- a/book.clj +++ b/book.clj @@ -69,7 +69,7 @@ ;; ;; 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") ;; ``` From 0611452e3b1d52e2fcf99a8a5a912314ae10719e Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Tue, 16 May 2023 18:23:15 +0200 Subject: [PATCH 03/16] fix typo: double "is" --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 3429218ef..aef719ea7 100644 --- a/book.clj +++ b/book.clj @@ -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. From ee395150c6bf2e46ff5de655daa6aa1ea271c7c1 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Tue, 16 May 2023 18:24:46 +0200 Subject: [PATCH 04/16] fix typo: exten(t/s)ion --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index aef719ea7..49dfd11c9 100644 --- a/book.clj +++ b/book.clj @@ -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 %)])} From e64a4d73201b1ab04b2953b14849b00c35c1116e Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Tue, 16 May 2023 18:40:10 +0200 Subject: [PATCH 05/16] fix words --- book.clj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book.clj b/book.clj index 49dfd11c9..286affc71 100644 --- a/book.clj +++ b/book.clj @@ -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] From 0a3d27000baaa618ae6f4c413c423f52a6dc8dfe Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Tue, 16 May 2023 18:40:51 +0200 Subject: [PATCH 06/16] spelling & comma --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 286affc71..c0dc152ba 100644 --- a/book.clj +++ b/book.clj @@ -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, From e0316f3e29b2b4e8c1a7cb954b071881c1e657cf Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 12:27:38 +0200 Subject: [PATCH 07/16] code span --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index c0dc152ba..60174bfb3 100644 --- a/book.clj +++ b/book.clj @@ -77,7 +77,7 @@ ;; ### ⏱ 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"]}) From c860b27b0d26f7dd8d029023aee341566e18178d Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 12:29:49 +0200 Subject: [PATCH 08/16] pluralize --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 60174bfb3..ed0b19568 100644 --- a/book.clj +++ b/book.clj @@ -183,7 +183,7 @@ ;; 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 +;; 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 with ;; keys are column names and rows are the values for that column. From 493c870fd01a716982f04799b2a3a7121979c271 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 12:30:27 +0200 Subject: [PATCH 09/16] wrong word --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index ed0b19568..bc0258859 100644 --- a/book.clj +++ b/book.clj @@ -184,7 +184,7 @@ ;; 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 seqs, which is just -;; a grid of values with an optional header; a map of seqs, in with +;; 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] From 5a1766069cf4592f34fcbe54c8bab1490b0d42e1 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 12:38:18 +0200 Subject: [PATCH 10/16] missing word --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index bc0258859..2239fd426 100644 --- a/book.clj +++ b/book.clj @@ -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 From 0c12a5655219ac8344524dd10181a81689f7995f Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 12:41:28 +0200 Subject: [PATCH 11/16] punctuation for end of sentence --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 2239fd426..85b3043fb 100644 --- a/book.clj +++ b/book.clj @@ -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 From b77de008d81479b591219cc11b493d9bf98d058b Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 12:52:29 +0200 Subject: [PATCH 12/16] bump total # of viewers --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 85b3043fb..ef5eb1bf6 100644 --- a/book.clj +++ b/book.clj @@ -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. From 71b07f80473352502ca9e1c39ef0f52a0d75d0c0 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 13:23:01 +0200 Subject: [PATCH 13/16] words --- book.clj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book.clj b/book.clj index ef5eb1bf6..7a01b4f16 100644 --- a/book.clj +++ b/book.clj @@ -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. From 4abe23c1054597da24d19c4919c9c6a4a48fd214 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 16:03:32 +0200 Subject: [PATCH 14/16] better word --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 7a01b4f16..223bbcb70 100644 --- a/book.clj +++ b/book.clj @@ -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 From 78c00be59a37c344e89d41eb4a7c8d50d5e8325a Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 17:44:08 +0200 Subject: [PATCH 15/16] spelling --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index 223bbcb70..ea0ed5a6c 100644 --- a/book.clj +++ b/book.clj @@ -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. From cbd2009013e2464f3e62d83b3308734c5ba66b66 Mon Sep 17 00:00:00 2001 From: Dave Liepmann Date: Wed, 17 May 2023 17:44:17 +0200 Subject: [PATCH 16/16] fix words --- book.clj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.clj b/book.clj index ea0ed5a6c..7dde293a6 100644 --- a/book.clj +++ b/book.clj @@ -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)