doc/tutorial/basics: some minor fixes

preparing for transformation to Hugo, mostlyl Change-Id: Iac74644a5e781912fd1e45cc39f60baa05d27683 Reviewed-on: https://cue-review.googlesource.com/c/cue/+/3263 Reviewed-by: Marcel van Lohuizen <[email protected]>
cuelang · Sep 12, 2019 · d44b092 · d44b092
1 parent 92408e3
commit d44b092
Show file tree

Hide file tree

Showing 14 changed files with 18 additions and 24 deletions.
diff --git a/doc/tutorial/basics/bytes.md b/doc/tutorial/basics/bytes.md
@@ -9,7 +9,7 @@ Bytes are converted to base64 when emitting JSON.
 Byte literals are defined with single quotes.
 The following additional escape sequences are allowed in byte literals:
 
-    \xnn    // arbitrary byte value defined as a 2-digit hexadecimal number
+    \xnn   // arbitrary byte value defined as a 2-digit hexadecimal number
     \nnn   // arbitrary byte value defined as a 3-digit octal number
 <!-- jba: this contradicts the spec, which has \nnn (no leading zero) -->
 
@@ -19,7 +19,7 @@ _bytes.cue:_
 a: '\x03abc'
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export bytes.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/commas.md b/doc/tutorial/basics/commas.md
@@ -25,7 +25,7 @@ _commas.cue:_
 ```
 
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export commas.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/commaslists.md b/doc/tutorial/basics/commaslists.md
@@ -18,7 +18,7 @@ _commas2.cue:_
 ]
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export commas2.cue`
 ```json
 [

diff --git a/doc/tutorial/basics/comments.md b/doc/tutorial/basics/comments.md
@@ -14,11 +14,11 @@ one: 1
 two: 2 // a line comment
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export comments.cue`
 ```json
 {
     "one": 1,
-    "two": 2,
+    "two": 2
 }
 ```
diff --git a/doc/tutorial/basics/curly.md b/doc/tutorial/basics/curly.md
@@ -17,7 +17,7 @@ two: 2
 "two-and-a-half": 2.5
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export curly.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/disjunctions.md b/doc/tutorial/basics/disjunctions.md
@@ -12,6 +12,7 @@ It is an error for a concrete `conn`
 to define anything else than these two values.
 
 <!-- CUE editor -->
+_disjunctions.cue_
 ```
 conn: {
     address:  string

diff --git a/doc/tutorial/basics/fieldname.md b/doc/tutorial/basics/fieldname.md
@@ -22,7 +22,7 @@ _fieldname.cue:_
 }
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export fieldname.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/fold.md b/doc/tutorial/basics/fold.md
@@ -12,7 +12,7 @@ _fold.cue:_
 outer middle inner: 3
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export fold.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/foldany.md b/doc/tutorial/basics/foldany.md
@@ -16,7 +16,7 @@ outer middle1 inner: 3
 outer middle2 inner: 7
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export foldany.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/numberlit.md b/doc/tutorial/basics/numberlit.md
@@ -18,7 +18,7 @@ _numlit.cue:_
 ]
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export numlit.cue`
 ```json
 [

diff --git a/doc/tutorial/basics/stringlit.md b/doc/tutorial/basics/stringlit.md
@@ -27,7 +27,7 @@ b: """
     """
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue export stringlit.cue`
 ```json
 {

diff --git a/doc/tutorial/basics/stringraw.md b/doc/tutorial/basics/stringraw.md
@@ -27,18 +27,16 @@ msg2: ##"""
     """##
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue eval stringraw.cue`
 ```
-{
-    msg1: "The sequence \"\\U0001F604\" renders as 😄."
-    msg2: """
+msg1: "The sequence \"\\U0001F604\" renders as 😄."
+msg2: """
         A regular expression can conveniently be written as:
         
             #\"\\d{3}\"#
         
         This construct works for bytes, strings and their
         multi-line variants.
         """
-}
 ```
diff --git a/doc/tutorial/basics/templates.md b/doc/tutorial/basics/templates.md
@@ -32,7 +32,7 @@ job nginx: {
 }
 ```
 
-<!-- JSON result -->
+<!-- result -->
 `$ cue eval templates.cue`
 ```
 job: {

diff --git a/doc/tutorial/basics/types.md b/doc/tutorial/basics/types.md
@@ -7,12 +7,7 @@ _Types ~~and~~ are Values_
 CUE defines the following basic types
 
 ```
-null
-bool
-string
-bytes
-int
-float
+null bool string bytes int float
 ```
 in addition to the error type mentioned in the previous section.
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,7 @@ _commas.cue:_ @@
     ```
-    <!-- JSON result -->
+    <!-- result -->
     `$ cue export commas.cue`
     ```json
     {
@@ Expand Down @@