git.iko.soy/urbit.org
on master help sign in
various standard library doc fixes
6d6967dJohn Franklin
reference/library/1b.udon+1−1
compare with master
unifiedsplit
@@ -10,7 +10,7 @@
10Check out the Nock [explanation](/docs/nock/explanation/) for more
10Check out the Nock [explanation](/docs/nock/explanation/) for more
11information on the tree-addressing system.
11information on the tree-addressing system.
12
12
13−### `++cap`(#anchors-in-markdown))
13+### `++cap`
14
14
15Tree head
15Tree head
16
16
reference/library/2n.udon+1−1
@@ -98,7 +98,7 @@ A gate.
98#### Examples
98#### Examples
99
99
100```
100```
101− > =tep (cury scan sym)
101+ > =tep (curr scan sym)
102 > `@t`(tep "asd")
102 > `@t`(tep "asd")
103 'asd'
103 'asd'
104
104
reference/library/3a.udon+6−6
@@ -534,7 +534,7 @@ A signed atom.
534```
534```
535
535
536---
536---
537−### `++new`
537+### `++new:si`
538
538
539Atom to @s
539Atom to @s
540
540
@@ -608,7 +608,7 @@ A cell composed of a `term` and an atom.
608```
608```
609
609
610---
610---
611−### `++pro`
611+### `++pro:si`
612
612
613Multiplication
613Multiplication
614
614
@@ -746,20 +746,20 @@ An atom.
746#### Examples
746#### Examples
747
747
748```
748```
749− > (mul 2 90)
749+ > (sun:si 90)
750 180
750 180
751
751
752− > (mul 2 --90)
752+ > (sun:si --90)
753 360
753 360
754 > `@u`--90
754 > `@u`--90
755 180
755 180
756
756
757− > (mul 2 --89)
757+ > (sun:si --89)
758 356
758 356
759 > `@u`--89
759 > `@u`--89
760 178
760 178
761
761
762− > (mul 2 -89)
762+ > (sun:si -89)
763 354
763 354
764 > `@u`-89
764 > `@u`-89
765 177
765 177
reference/library/3b.udon+40−40
@@ -1065,7 +1065,7 @@ The default value of `d` is `%d`.
1065```
1065```
1066
1066
1067---
1067---
1068−### `++emn:si`
1068+### `++emn:fl`
1069
1069
1070Minimum exponent
1070Minimum exponent
1071
1071
@@ -2079,7 +2079,7 @@ A `unit` of @s.
2079```
2079```
2080
2080
2081---
2081---
2082−### `+ff`
2082+### `++ff`
2083
2083
2084IEEE-754 Formatting
2084IEEE-754 Formatting
2085
2085
@@ -2110,7 +2110,7 @@ Container core for IEEE-754 formatting operations.
2110---
2110---
2111#### Discussion
2111#### Discussion
2112
2112
2113−`+ff` has no use outside of the functionality provided to other cores: `++rd`,
2113+`++ff` has no use outside of the functionality provided to other cores: `++rd`,
2114`++rs`, `++rq`, and `++rh`. It's not intended to be used directly; it's just
2114`++rs`, `++rq`, and `++rh`. It's not intended to be used directly; it's just
2115meant to power those cores.
2115meant to power those cores.
2116
2116
@@ -2187,7 +2187,7 @@ configuration of the `ff` core.
2187internal use in other cores.
2187internal use in other cores.
2188
2188
2189---
2189---
2190−### `++sea`
2190+### `++sea:ff`
2191
2191
2192`@r` to `fn`
2192`@r` to `fn`
2193
2193
@@ -2325,7 +2325,7 @@ A `flag`.
2325```
2325```
2326
2326
2327---
2327---
2328−### `++exp`
2328+### `++exp:ff`
2329
2329
2330Get exponent
2330Get exponent
2331
2331
@@ -2355,7 +2355,7 @@ A signed integer.
2355```
2355```
2356
2356
2357---
2357---
2358−### `++add`
2358+### `++add:ff`
2359
2359
2360Add
2360Add
2361
2361
@@ -2419,7 +2419,7 @@ A `@r`, an IEEE float.
2419```
2419```
2420
2420
2421---
2421---
2422−### `mul:ff`
2422+### `++mul:ff`
2423
2423
2424Multiply
2424Multiply
2425
2425
@@ -2616,7 +2616,7 @@ A `flag`.
2616```
2616```
2617
2617
2618---
2618---
2619−### `equ:ff`
2619+### `++equ:ff`
2620
2620
2621Equals
2621Equals
2622
2622
@@ -2867,7 +2867,7 @@ A `@r`, an IEEE float.
2867```
2867```
2868
2868
2869---
2869---
2870−### `rlyd`
2870+### `++rlyd`
2871
2871
2872Prep `@rd` for print
2872Prep `@rd` for print
2873
2873
@@ -3143,7 +3143,7 @@ configuration of the `rd` core.
3143```
3143```
3144
3144
3145---
3145---
3146−### `sea:rd`
3146+### `++sea:rd`
3147
3147
3148`@rd` to `fn`
3148`@rd` to `fn`
3149
3149
@@ -3162,7 +3162,7 @@ Converts `a` from a double-precision binary float to `fn`.
3162```
3162```
3163
3163
3164---
3164---
3165−### `bit:rd`
3165+### `++bit:rd`
3166
3166
3167`fn` to `@rd`
3167`fn` to `@rd`
3168
3168
@@ -3191,7 +3191,7 @@ A `@rd`, a double-precision float.
3191```
3191```
3192
3192
3193---
3193---
3194−### `add:rd`
3194+### `++add:rd`
3195
3195
3196Add
3196Add
3197
3197
@@ -3224,7 +3224,7 @@ A `@rd`.
3224```
3224```
3225
3225
3226---
3226---
3227−### `sub:rd`
3227+### `++sub:rd`
3228
3228
3229Subtract
3229Subtract
3230
3230
@@ -3257,7 +3257,7 @@ A `@rd`.
3257```
3257```
3258
3258
3259---
3259---
3260−### `sub:rd`
3260+### `++mul:rd`
3261
3261
3262Multiply
3262Multiply
3263
3263
@@ -3290,7 +3290,7 @@ A `@rd`.
3290```
3290```
3291
3291
3292---
3292---
3293−### `div:rd`
3293+### `++div:rd`
3294
3294
3295Divide
3295Divide
3296
3296
@@ -3362,7 +3362,7 @@ A `@rd`.
3362```
3362```
3363
3363
3364---
3364---
3365−### `+sqt:fr`
3365+### `++sqt:rd`
3366
3366
3367Square root
3367Square root
3368
3368
@@ -3392,7 +3392,7 @@ A `@rd`.
3392```
3392```
3393
3393
3394---
3394---
3395−### `lth:rd`
3395+### `++lth:rd`
3396
3396
3397Less than
3397Less than
3398
3398
@@ -3470,7 +3470,7 @@ A `@rd`.
3470```
3470```
3471
3471
3472---
3472---
3473−### `equ:rd`
3473+### `++equ:rd`
3474
3474
3475Equals
3475Equals
3476
3476
@@ -3576,14 +3576,14 @@ A `@rd`.
3576#### Examples
3576#### Examples
3577
3577
3578```
3578```
3579− > (gte:rd .~7.94099e2 .~1.2246e3)
3579+ > (gth:rd .~7.94099e2 .~1.2246e3)
3580 %.n
3580 %.n
3581
3581
3582− > (gte:rd .~7.94099e2 .~1.2246e2)
3582+ > (gth:rd .~7.94099e2 .~1.2246e2)
3583 %.y
3583 %.y
3584
3584
3585− > (gte:rd .~1.2246e2 .~1.2246e2)
3585+ > (gth:rd .~1.2246e2 .~1.2246e2)
3586− %.y
3586+ %.n
3587```
3587```
3588
3588
3589---
3589---
@@ -3671,7 +3671,7 @@ A `flag`.
3671```
3671```
3672
3672
3673---
3673---
3674−### `exp:rd`
3674+### `++exp:rd`
3675
3675
3676Get exponent
3676Get exponent
3677
3677
@@ -3804,7 +3804,7 @@ down (`$d`), and round to zero (`$z`).
3804```
3804```
3805
3805
3806---
3806---
3807−### `ma:rs`
3807+### `++ma:rs`
3808
3808
3809Initialize `ff`
3809Initialize `ff`
3810
3810
@@ -3828,7 +3828,7 @@ configuration of the `rs` core.
3828```
3828```
3829
3829
3830---
3830---
3831−### `sea:rs`
3831+### `++sea:rs`
3832
3832
3833`@rs` to `fn`
3833`@rs` to `fn`
3834
3834
@@ -3857,7 +3857,7 @@ An `fn`.
3857```
3857```
3858
3858
3859---
3859---
3860−### `bit:rs`
3860+### `++bit:rs`
3861
3861
3862`fn` to `@rs`
3862`fn` to `@rs`
3863
3863
@@ -4075,7 +4075,7 @@ A `@rs`.
4075```
4075```
4076
4076
4077---
4077---
4078−### `lth:rs`
4078+### `++lth:rs`
4079
4079
4080Less than
4080Less than
4081
4081
@@ -4147,7 +4147,7 @@ A `@rs`.
4147```
4147```
4148
4148
4149---
4149---
4150−### `equ:rs`
4150+### `++equ:rs`
4151
4151
4152Equals
4152Equals
4153
4153
@@ -4344,7 +4344,7 @@ A `flag`.
4344```
4344```
4345
4345
4346---
4346---
4347−### `exp:rs`
4347+### `++exp:rs`
4348
4348
4349Get exponent
4349Get exponent
4350
4350
@@ -4651,7 +4651,7 @@ A `@rq`.
4651```
4651```
4652
4652
4653---
4653---
4654−### `div:rq`
4654+### `++div:rq`
4655
4655
4656Divide
4656Divide
4657
4657
@@ -4684,7 +4684,7 @@ A `@rq`.
4684```
4684```
4685
4685
4686---
4686---
4687−### `fma:rq`
4687+### `++fma:rq`
4688
4688
4689Fused multiply-add
4689Fused multiply-add
4690
4690
@@ -4720,7 +4720,7 @@ A `@rq`.
4720```
4720```
4721
4721
4722---
4722---
4723−#### Source
4723+### `++sqt:rq`
4724
4724
4725Square root
4725Square root
4726
4726
@@ -4788,7 +4788,7 @@ A `@rq`.
4788```
4788```
4789
4789
4790---
4790---
4791−### `lte:rq`
4791+### `++lte:rq`
4792
4792
4793Less than or equal
4793Less than or equal
4794
4794
@@ -5337,7 +5337,7 @@ A `@rh`.
5337```
5337```
5338
5338
5339---
5339---
5340−### `div:rh`
5340+### `++div:rh`
5341
5341
5342Divide
5342Divide
5343
5343
@@ -5370,7 +5370,7 @@ A `@rh`.
5370```
5370```
5371
5371
5372---
5372---
5373−### `fma:rh`
5373+### `++fma:rh`
5374
5374
5375Fused multiply-add
5375Fused multiply-add
5376
5376
@@ -5406,7 +5406,7 @@ A `@rh`.
5406```
5406```
5407
5407
5408---
5408---
5409−#### Source
5409+### `++sqt:rh`
5410
5410
5411Square root
5411Square root
5412
5412
@@ -5473,7 +5473,7 @@ A `@rh`.
5473```
5473```
5474
5474
5475---
5475---
5476−### `lte:rh`
5476+### `++lte:rh`
5477
5477
5478Less than or equal
5478Less than or equal
5479
5479
@@ -5501,10 +5501,10 @@ A `@rh`.
5501#### Examples
5501#### Examples
5502
5502
5503```
5503```
5504− > (lth:rh .~~1.2e5 (mul:rh .~~9.02e2 .~~7.114e2))
5504+ > (lte:rh .~~1.2e5 (mul:rh .~~9.02e2 .~~7.114e2))
5505 %.n
5505 %.n
5506
5506
5507− > (lth:rh .~~1.2e3 (mul:rh .~~9.02e1 .~~7.114e2))
5507+ > (lte:rh .~~1.2e3 (mul:rh .~~9.02e1 .~~7.114e2))
5508 %.y
5508 %.y
5509
5509
5510 > (lte:rh .~~1.2e3 .~~1.2e3)
5510 > (lte:rh .~~1.2e3 .~~1.2e3)
@@ -5736,7 +5736,7 @@ A `@s`, a signed integer.
5736```
5736```
5737
5737
5738---
5738---
5739−### `toi:rh`
5739+### `++toi:rh`
5740
5740
5741Round to integer
5741Round to integer
5742
5742
reference/library/3d.udon+15−15
@@ -36,7 +36,7 @@ An atom.
36 718.295.626.625.655.417.234
36 718.295.626.625.655.417.234
37```
37```
38
38
39−***
39+---
40### `++shaf`
40### `++shaf`
41
41
42Half SHA-256
42Half SHA-256
@@ -71,7 +71,7 @@ first and last halves of the 256-bit salted hash `shas`.
71 \/
71 \/
72```
72```
73
73
74−***
74+---
75### `++shal`
75### `++shal`
76
76
77SHA-512 with length
77SHA-512 with length
@@ -227,7 +227,7 @@ Because byte-strings can have leading zeros, but atoms cannot, we use `len`
227as a way of saying that the atom `ruz` is shorter than its representative
227as a way of saying that the atom `ruz` is shorter than its representative
228byte-string.
228byte-string.
229
229
230−***
230+---
231### `++sham`
231### `++sham`
232
232
233128-bit noun hash
233128-bit noun hash
@@ -265,7 +265,7 @@ An atom.
265 0v1.hg8mv.t7s3f.u4f8a.q5noe.dvqvh
265 0v1.hg8mv.t7s3f.u4f8a.q5noe.dvqvh
266```
266```
267
267
268−***
268+---
269### `++shan`
269### `++shan`
270
270
271SHA-1
271SHA-1
@@ -361,7 +361,7 @@ An atom.
361
361
362SHA-1 is a deprecated function; it is not considered secure.
362SHA-1 is a deprecated function; it is not considered secure.
363
363
364−***
364+---
365### `++shas`
365### `++shas`
366
366
367Salted hash
367Salted hash
@@ -393,7 +393,7 @@ of that logical operation is then itself hashed with SHA-256.
393 \/
393 \/
394```
394```
395
395
396−***
396+---
397### `++shaw`
397### `++shaw`
398
398
399Hash to nbits
399Hash to nbits
@@ -431,7 +431,7 @@ An atom.
431 0b11
431 0b11
432```
432```
433
433
434−***
434+---
435### `++shax`
435### `++shax`
436
436
437SHA-256
437SHA-256
@@ -456,7 +456,7 @@ Produces an atom by hashing an atom `ruz` with SHA-256.
456 \/
456 \/
457```
457```
458
458
459−***
459+---
460### `++shay`
460### `++shay`
461
461
462SHA-256 with length
462SHA-256 with length
@@ -580,7 +580,7 @@ Because byte-strings can have leading zeros, but atoms cannot, we use `len`
580as a way of saying that the atom `ruz` is shorter than its representative
580as a way of saying that the atom `ruz` is shorter than its representative
581byte-string.
581byte-string.
582
582
583−***
583+---
584### `++shaz`
584### `++shaz`
585
585
586SHA-512
586SHA-512
@@ -613,7 +613,7 @@ An atom.
613 \/
613 \/
614```
614```
615
615
616−***
616+---
617### `++og`
617### `++og`
618
618
619Container arm for SHA-256-powered random-number generation. Its sample `a` is an
619Container arm for SHA-256-powered random-number generation. Its sample `a` is an
@@ -648,7 +648,7 @@ Note that the product is deterministic; the seed will produce the same
648result every time it is run. Use `eny`, 256 bits of entropy, for a
648result every time it is run. Use `eny`, 256 bits of entropy, for a
649non-deterministic product.
649non-deterministic product.
650
650
651−***
651+---
652### `++rad`
652### `++rad`
653
653
654Random in range
654Random in range
@@ -689,7 +689,7 @@ An atom.
689 7
689 7
690```
690```
691
691
692−***
692+---
693### `++rads`
693### `++rads`
694
694
695Random continuation
695Random continuation
@@ -734,7 +734,7 @@ Since everything in Hoon is a pure function, we need to use tricks like this to
734generate separate random values from the same seed. Notice how we jump from
734generate separate random values from the same seed. Notice how we jump from
735one `rads` function call to another in the above example.
735one `rads` function call to another in the above example.
736
736
737−***
737+---
738### `++raw`
738### `++raw`
739
739
740Random bits
740Random bits
@@ -783,7 +783,7 @@ An atom.
783 0b100
783 0b100
784```
784```
785
785
786−***
786+---
787### `++raws`
787### `++raws`
788
788
789Random bits continuation
789Random bits continuation
@@ -821,4 +821,4 @@ Since everything in Hoon is a pure function, we need to use tricks like this to
821generate separate random values from the same seed. Notice how we jump from
821generate separate random values from the same seed. Notice how we jump from
822one `raws` function call to another in the above example.
822one `raws` function call to another in the above example.
823
823
824−***
824+---
reference/library/4c.udon+1−1
@@ -364,4 +364,4 @@ XX document
364
364
365
365
366
366
367−***
367+---
reference/library/4d.udon+1−1
@@ -101,4 +101,4 @@ A hair.
101 [2 6]
101 [2 6]
102```
102```
103
103
104−***
104+---
reference/library/4g.udon+1−1
@@ -57,7 +57,7 @@ The value of the parse result, or crash.
57
57
58Parse or null
58Parse or null
59
59
60−Parse a given with a given rule and produce null if the cord isn't
60+Parse an atom with a given rule and produce null if the cord isn't
61entirely parsed.
61entirely parsed.
62
62
63#### Accepts
63#### Accepts