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 + 7 files changed, 27 insertions(+), 9 deletions(-) (limited to 'docs') 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
-- 
cgit v1.2.3