Doc updates for #960

johnkerl · Feb 22, 2022 · 277d2d0 · 277d2d0
1 parent 6dde90a
commit 277d2d0
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 23 deletions.
diff --git a/docs/src/reference-main-arrays.md b/docs/src/reference-main-arrays.md
@@ -139,9 +139,9 @@ x[4], x[5]]`.
 
 ## Out-of-bounds indexing
 
-Somewhat imitating Python, out-of-bounds index accesses are
-[absent](reference-main-null-data.md), but out-of-bounds slice accesses result
-in trimming the indices, resulting in a short array or even the empty array:
+Out-of-bounds index accesses are [absent](reference-main-null-data.md), but out-of-bounds slice
+accesses result in trimming the indices, resulting in a short array or even the empty array.  (This
+behavior intentionally imitates Python.)
 
 <pre class="pre-highlight-in-pair">
 <b>mlr -n put '</b>

diff --git a/docs/src/reference-main-arrays.md.in b/docs/src/reference-main-arrays.md.in
@@ -94,9 +94,9 @@ GENMD-EOF
 
 ## Out-of-bounds indexing
 
-Somewhat imitating Python, out-of-bounds index accesses are
-[absent](reference-main-null-data.md), but out-of-bounds slice accesses result
-in trimming the indices, resulting in a short array or even the empty array:
+Out-of-bounds index accesses are [absent](reference-main-null-data.md), but out-of-bounds slice
+accesses result in trimming the indices, resulting in a short array or even the empty array.  (This
+behavior intentionally imitates Python.)
 
 GENMD-RUN-COMMAND
 mlr -n put '

diff --git a/docs/src/reference-main-strings.md b/docs/src/reference-main-strings.md
@@ -122,17 +122,17 @@ bcd
 
 ## Out-of-bounds indexing
 
-Somewhat imitating Python, out-of-bounds index accesses are
-[errors](reference-main-data-types.md), but out-of-bounds slice accesses result
-in trimming the indices, resulting in a short string or even the empty string:
+Out-of-bounds index accesses are [errors](reference-main-data-types.md), but out-of-bounds slice
+accesses result in trimming the indices, resulting in a short string or even the empty string.
+(This behavior intentionally imitates Python.)
 
 <pre class="pre-highlight-in-pair">
 <b>mlr -n put '</b>
 <b>  end {</b>
 <b>    x = "abcde";</b>
 <b>    print x[1];</b>
 <b>    print x[5];</b>
-<b>    print x[6]; # absent</b>
+<b>    print x[6];</b>
 <b>  }</b>
 <b>'</b>
 </pre>
@@ -146,16 +146,16 @@ e
 <b>mlr -n put '</b>
 <b>  end {</b>
 <b>    x = "abcde";</b>
-<b>    print x[1:2];</b>
-<b>    print x[1:6];</b>
-<b>    print x[10:20];</b>
+<b>    print "\"" . x[1:2] . "\"";</b>
+<b>    print "\"" . x[1:6] . "\"";</b>
+<b>    print "\"" . x[10:20] . "\"";</b>
 <b>  }</b>
 <b>'</b>
 </pre>
 <pre class="pre-non-highlight-in-pair">
-ab
-abcde
-
+"ab"
+"abcde"
+""
 </pre>
 
 ## Escape sequences for string literals

diff --git a/docs/src/reference-main-strings.md.in b/docs/src/reference-main-strings.md.in
@@ -80,17 +80,17 @@ GENMD-EOF
 
 ## Out-of-bounds indexing
 
-Somewhat imitating Python, out-of-bounds index accesses are
-[errors](reference-main-data-types.md), but out-of-bounds slice accesses result
-in trimming the indices, resulting in a short string or even the empty string:
+Out-of-bounds index accesses are [errors](reference-main-data-types.md), but out-of-bounds slice
+accesses result in trimming the indices, resulting in a short string or even the empty string.
+(This behavior intentionally imitates Python.)
 
 GENMD-RUN-COMMAND
 mlr -n put '
   end {
     x = "abcde";
     print x[1];
     print x[5];
-    print x[6]; # absent
+    print x[6];
   }
 '
 GENMD-EOF
@@ -99,9 +99,9 @@ GENMD-RUN-COMMAND
 mlr -n put '
   end {
     x = "abcde";
-    print x[1:2];
-    print x[1:6];
-    print x[10:20];
+    print "\"" . x[1:2] . "\"";
+    print "\"" . x[1:6] . "\"";
+    print "\"" . x[10:20] . "\"";
   }
 '
 GENMD-EOF