From 224d6ed83efb86fa16ac802af65c63d1b97543e2 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Sat, 29 Jan 2022 17:48:16 -0500 Subject: More detail in a few help pages --- docs/help/depth.html | 7 +++++-- docs/help/leftargument.html | 12 +++++++++++- docs/help/length_notequals.html | 1 + docs/help/merge_greaterthan.html | 5 ++--- docs/help/nothing.html | 8 ++++++-- docs/help/rank.html | 2 +- docs/help/rank_equals.html | 1 + help/depth.md | 4 +++- help/leftargument.md | 8 ++++++++ help/length_notequals.md | 2 ++ help/merge_greaterthan.md | 6 ++---- help/nothing.md | 8 ++++++-- help/rank.md | 2 +- help/rank_equals.md | 2 ++ 14 files changed, 51 insertions(+), 17 deletions(-) diff --git a/docs/help/depth.html b/docs/help/depth.html index 03fcaea6..4657a433 100644 --- a/docs/help/depth.html +++ b/docs/help/depth.html @@ -7,10 +7,13 @@

Circle With Two Dots (βš‡)

π”½βš‡π•˜ 𝕩, 𝕨 π”½βš‡π•˜ 𝕩: Depth

β†’full documentation

-

Apply 𝔽 to the cells of the arguments at depth given in π•˜.

-↗️
    1βŠΈβ†“βš‡1 ⟨⟨1,2,3⟩, ⟨4,5,6⟩⟩
+
Apply 𝔽 to the cells of the arguments at depth given in π•˜. Negative numbers count down from the top level and non-negative ones from the bottom up.

+↗️
    1βŠΈβ†“βš‡1 ⟨⟨1,2,3⟩, ⟨4,5,6⟩⟩
 ⟨ ⟨ 2 3 ⟩ ⟨ 5 6 ⟩ ⟩
 
     1 β†“βš‡1 ⟨⟨1,2,3⟩, ⟨4,5,6⟩⟩
 ⟨ ⟨ 2 3 ⟩ ⟨ 5 6 ⟩ ⟩
+
+    (+´↕)βš‡0 ⟨2,4β€Ώ7,3⟩  # Implements pervasion
+⟨ 1 ⟨ 6 21 ⟩ 3 ⟩
 

diff --git a/docs/help/leftargument.html b/docs/help/leftargument.html
index 2c92de98..58c60486 100644
--- a/docs/help/leftargument.html
+++ b/docs/help/leftargument.html
@@ -8,6 +8,16 @@
 
𝕨: Left Argument

 
β†’full documentation

 
A variable assigned to the left argument of a block. π•Ž can be used to access the left argument as a function.

-↗️
    5 {𝕨} 1
+↗️
    5 {𝕨} 1
 5
+
+    -β€ΏΓ· {π•Žπ•©}Β¨ 4
+⟨ ¯4 0.25 ⟩
+

+
In a call with no left argument, 𝕨 functions as Nothing and π•Ž can't be used.

+↗️
    {(-𝕨)β‹ˆπ•©} 6
+⟨ 6 ⟩
+
+    2 {(-𝕨)β‹ˆπ•©} 6
+⟨ ¯2 6 ⟩
 

diff --git a/docs/help/length_notequals.html b/docs/help/length_notequals.html
index 3667e2fe..9efb3a35 100644
--- a/docs/help/length_notequals.html
+++ b/docs/help/length_notequals.html
@@ -25,6 +25,7 @@
 

 
𝕨 β‰  𝕩: Not Equal To

 
β†’full documentation

+
Do argument atoms not match?

 
Pervasive.

 ↗️
    1 β‰  3
 1
diff --git a/docs/help/merge_greaterthan.html b/docs/help/merge_greaterthan.html
index c0b21032..da588aa8 100644
--- a/docs/help/merge_greaterthan.html
+++ b/docs/help/merge_greaterthan.html
@@ -7,9 +7,8 @@
 
Greater Than (>)

 
> 𝕩: Merge

 
β†’full documentation

-
Add the rank of an element of 𝕩 to the rank of 𝕩.

-
All elements must have the same rank.

-
Returns atomic values as is.

+
Combine an array of arrays into one array. All elements of 𝕩 must have the same rank, and the result rank is that plus the rank of 𝕩.

+
Returns and boxed atoms unchanged.

 ↗️
    a ← ⟨⟨1, 2⟩, ⟨3, 4⟩⟩
 
     >a
diff --git a/docs/help/nothing.html b/docs/help/nothing.html
index b83a26c4..f4361a83 100644
--- a/docs/help/nothing.html
+++ b/docs/help/nothing.html
@@ -7,6 +7,10 @@
 
Middle Dot (Β·)

 
Β·: Nothing

 
β†’full documentation

+
Indicates no value. If a left argument is Nothing, the function is called with no left argument, and if the right is Nothing, it's not called and "returns" Nothing.

+↗️
    · ⌽ "abc"  # Reverse instead of Rotate
+"cba"
+

 
In Trains

 
Nothing can serve as a left argument in a train to string together multiple monadic functions.

 ↗️
    (-+-) 5
@@ -15,8 +19,8 @@
     (-Β·+-) 5
 5
 

-
In Block Headers

-
For Block header pattern matching syntax, Nothing can be used to indicate an unused value.

+
Destructuring

+
For pattern matching in assignment or a block header, Nothing indicates an unused value.

 ↗️
    F ← {π•Š aβ€ΏΒ·β€Ώb: a∾b}
 
     F 1β€Ώ2β€Ώ3
diff --git a/docs/help/rank.html b/docs/help/rank.html
index 1789d21f..e296e97a 100644
--- a/docs/help/rank.html
+++ b/docs/help/rank.html
@@ -6,7 +6,7 @@
 
(github) / BQN / help

 
Circled Horizontal Bar With Notch (βŽ‰)

 
π”½βŽ‰π•˜ 𝕩, 𝕨 π”½βŽ‰π•˜ 𝕩: Rank

-
Apply 𝔽 to cells at ranks given in π•˜.

+
Apply 𝔽 to cells at ranks given in π•˜. Non-negative numbers indicate the rank of the cell and negative ones indicate the difference from full rank.

 
The ranks applied are given by the following:

 
    
 
  • βŽ‰ c    Rank-c cells of 𝕩 (monadic) or both arguments (dyadic)
    • 
diff --git a/docs/help/rank_equals.html b/docs/help/rank_equals.html
index bd5b3727..65313deb 100644
--- a/docs/help/rank_equals.html
+++ b/docs/help/rank_equals.html
@@ -34,6 +34,7 @@
 

 
𝕨 = 𝕩: Equal To

 
β†’full documentation

+
Do argument atoms match?

 
Pervasive.

 ↗️
    1 = 3
 0
diff --git a/help/depth.md b/help/depth.md
index 8c0d4367..bbe4d297 100644
--- a/help/depth.md
+++ b/help/depth.md
@@ -5,9 +5,11 @@
 ## `π”½βš‡π•˜ 𝕩`, `𝕨 π”½βš‡π•˜ 𝕩`: Depth
 [β†’full documentation](../doc/depth.md#the-depth-modifier)
 
-Apply `𝔽` to the cells of the arguments at depth given in `π•˜`.
+Apply `𝔽` to the cells of the arguments at depth given in `π•˜`. Negative numbers count down from the top level and non-negative ones from the bottom up.
 
 
         1βŠΈβ†“βš‡1 ⟨⟨1,2,3⟩, ⟨4,5,6⟩⟩
 
         1 β†“βš‡1 ⟨⟨1,2,3⟩, ⟨4,5,6⟩⟩
+
+        (+´↕)βš‡0 ⟨2,4β€Ώ7,3⟩  # Implements pervasion
diff --git a/help/leftargument.md b/help/leftargument.md
index f8031f26..bda7fedc 100644
--- a/help/leftargument.md
+++ b/help/leftargument.md
@@ -8,3 +8,11 @@
 A variable assigned to the left argument of a block. `π•Ž` can be used to access the left argument as a function.
 
         5 {𝕨} 1
+
+        -β€ΏΓ· {π•Žπ•©}Β¨ 4
+
+In a call with no left argument, `𝕨` functions as [Nothing](nothing.md) and `π•Ž` can't be used.
+
+        {(-𝕨)β‹ˆπ•©} 6
+
+        2 {(-𝕨)β‹ˆπ•©} 6
diff --git a/help/length_notequals.md b/help/length_notequals.md
index 5d17237c..e13a14fe 100644
--- a/help/length_notequals.md
+++ b/help/length_notequals.md
@@ -23,6 +23,8 @@ Length of the first dimension of `𝕩`.
 ## `𝕨 β‰  𝕩`: Not Equal To
 [β†’full documentation](../doc/arithmetic.md#comparisons)
 
+Do argument atoms not match?
+
 [Pervasive.](../doc/arithmetic.md#pervasion)
 
         1 β‰  3
diff --git a/help/merge_greaterthan.md b/help/merge_greaterthan.md
index ee315fca..e78c063a 100644
--- a/help/merge_greaterthan.md
+++ b/help/merge_greaterthan.md
@@ -5,11 +5,9 @@
 ## `> 𝕩`: Merge
 [β†’full documentation](../doc/couple.md)
 
-Add the rank of an element of `𝕩` to the rank of `𝕩`.
+Combine an array of arrays into one array. All elements of `𝕩` must have the same rank, and the result rank is that plus the rank of `𝕩`.
 
-All elements must have the same rank.
-
-Returns atomic values as is.
+Returns and boxed atoms unchanged.
 
 
         a ← ⟨⟨1, 2⟩, ⟨3, 4⟩⟩
diff --git a/help/nothing.md b/help/nothing.md
index 0a5ad783..23aee6ba 100644
--- a/help/nothing.md
+++ b/help/nothing.md
@@ -5,6 +5,10 @@
 ## `Β·`: Nothing
 [β†’full documentation](../doc/expression.md#nothing)
 
+Indicates no value. If a left argument is Nothing, the function is called with no left argument, and if the right is Nothing, it's not called and "returns" Nothing.
+
+        · ⌽ "abc"  # Reverse instead of Rotate
+
 ### In Trains
 
 Nothing can serve as a left argument in a train to string together multiple monadic functions.
@@ -13,9 +17,9 @@ Nothing can serve as a left argument in a train to string together multiple mona
 
         (-Β·+-) 5
 
-### In Block Headers
+### Destructuring
 
-For Block header pattern matching syntax, Nothing can be used to indicate an unused value.
+For pattern matching in assignment or a block header, Nothing indicates an unused value.
 
         F ← {π•Š aβ€ΏΒ·β€Ώb: a∾b}
 
diff --git a/help/rank.md b/help/rank.md
index 8f9e83ac..a3dddaf5 100644
--- a/help/rank.md
+++ b/help/rank.md
@@ -4,7 +4,7 @@
 
 ## `π”½βŽ‰π•˜ 𝕩`, `𝕨 π”½βŽ‰π•˜ 𝕩`: Rank
 
-Apply `𝔽` to cells at ranks given in `π•˜`.
+Apply `𝔽` to cells at ranks given in `π•˜`. Non-negative numbers indicate the rank of the cell and negative ones indicate the difference from full rank.
 
 The ranks applied are given by the following:
 
diff --git a/help/rank_equals.md b/help/rank_equals.md
index 0f41f6fa..ed590408 100644
--- a/help/rank_equals.md
+++ b/help/rank_equals.md
@@ -21,6 +21,8 @@ Returns the number of dimensions in `𝕩`.
 ## `𝕨 = 𝕩`: Equal To
 [β†’full documentation](../doc/arithmetic.md#comparisons)
 
+Do argument atoms match?
+
 [Pervasive.](../doc/arithmetic.md#pervasion)
 
         1 = 3
-- 
cgit v1.2.3