mirror of
https://github.com/ilyakooo0/urbit.git
synced 2024-11-11 04:48:00 +03:00
Change docs calling runes 'hoons'
This commit is contained in:
parent
c81ee53427
commit
b8e87746ba
@ -3,7 +3,7 @@ bucket `$^` %bckt
|
||||
|
||||
Normalizing gate, `%herb`
|
||||
|
||||
`$^`, is a tile hoon that declares an [`%herb`](). An `%herb` is a gate,
|
||||
`$^`, is a tile rune that declares an [`%herb`](). An `%herb` is a gate,
|
||||
accepting a sample of \* and normalizing it as you choose. If you use a
|
||||
twig as a tile, it's treated as an herb.
|
||||
|
||||
|
@ -3,7 +3,7 @@ barcab, `|_`, %brcb
|
||||
|
||||
Door: core with sample
|
||||
|
||||
`|_` is a synthetic hoon that produces a [`%gold`]() [door]() with
|
||||
`|_` is a synthetic rune that produces a [`%gold`]() [door]() with
|
||||
sample `p` and [arms]() `q`. The list must be closed with a `--`.
|
||||
|
||||
`|_` is similar to `|%`, but defines a sample for the set of arms it
|
||||
|
@ -3,7 +3,7 @@ bardot, `|.`, %brdt
|
||||
|
||||
Trap
|
||||
|
||||
`|.`, is a synthetic hoon that produces a [dry]() [`%gold`]() trap. A
|
||||
`|.`, is a synthetic rune that produces a [dry]() [`%gold`]() trap. A
|
||||
trap is a [`door`]() with one only arm [`$`](), the empty name.
|
||||
|
||||
The default action performed on a trap is kicking it by pulling the arm
|
||||
|
@ -3,7 +3,7 @@ bartar, `|*`, %brtr
|
||||
|
||||
Wet gate
|
||||
|
||||
`|*` is a synthetic hoon that produces a [wet]() [gate]() with sample
|
||||
`|*` is a synthetic rune that produces a [wet]() [gate]() with sample
|
||||
[`$*(p)`](), arm `q`. A gate is a core with one arm, [`$`](), the empty
|
||||
name.
|
||||
|
||||
|
@ -3,7 +3,7 @@ colfas, `:/`, %clfs
|
||||
|
||||
Internal interpolation
|
||||
|
||||
`:/`, `colfas`, is a synthetic hoon that produces `[%$ [%$ p ~] ~]`,
|
||||
`:/`, `colfas`, is a synthetic rune that produces `[%$ [%$ p ~] ~]`,
|
||||
i.e., `[0 [0 p 0] 0]`.
|
||||
|
||||
See also
|
||||
|
@ -3,7 +3,7 @@ coltar, `:*`, %cltr
|
||||
|
||||
Tuple
|
||||
|
||||
`:*`, `coltar`, `[%cltr p=tusk]` is a synthetic hoon that produces a
|
||||
`:*`, `coltar`, `[%cltr p=tusk]` is a synthetic rune that produces a
|
||||
tuple.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ centis, `%=`, %cnts
|
||||
|
||||
Evaluate with changes
|
||||
|
||||
`%=` is a natural hoon that evaluates `p` with the changes specified in
|
||||
`%=` is a natural rune that evaluates `p` with the changes specified in
|
||||
`q`. `%=` is used to change a batch of [wing]()s inside a [`++wing`]()
|
||||
all at once, ensuring that the product is type checked.
|
||||
|
||||
|
@ -3,7 +3,7 @@ cenzaz, %cnzz
|
||||
|
||||
Pull wing `p`
|
||||
|
||||
`cenzaz` is a synthetic hoon that pulls wing `p` from the subject.
|
||||
`cenzaz` is a synthetic rune that pulls wing `p` from the subject.
|
||||
`cenzaz` is only used internally by `hoon.hoon`, but is used implicitly
|
||||
whenever dereferencing occurs.
|
||||
|
||||
|
@ -3,7 +3,7 @@ dotket, `.^`, %dtkt
|
||||
|
||||
Load from `%clay`
|
||||
|
||||
`.^`, `dotket`, `[%dtkt p=twig]` is a natural hoon that generates nock
|
||||
`.^`, `dotket`, `[%dtkt p=twig]` is a natural rune that generates nock
|
||||
operator `11`, which in virtual userspace nock, [`++mock`]() loads a
|
||||
file from the global namespace.
|
||||
|
||||
|
@ -3,7 +3,7 @@ dotlus, `.+`, %dtls
|
||||
|
||||
Increment
|
||||
|
||||
`.+` is a natural hoon that generates nock operator `4`, which
|
||||
`.+` is a natural rune that generates nock operator `4`, which
|
||||
increments an atomic operand.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ dottar, `.*`, %dttr
|
||||
|
||||
Nock
|
||||
|
||||
`.*` is a natural hoon that calculates the nock of subject `p` and
|
||||
`.*` is a natural rune that calculates the nock of subject `p` and
|
||||
formula `q`. `.*` makes it possible to compute nock formulas in user
|
||||
space.
|
||||
|
||||
|
@ -3,7 +3,7 @@ dotwut,`.?`, %dtwt
|
||||
|
||||
Noun or cell
|
||||
|
||||
`.?`, `dotwut`, `[%dtwt p=twig]` is a natural hoon that applies nock `3`
|
||||
`.?`, `dotwut`, `[%dtwt p=twig]` is a natural rune that applies nock `3`
|
||||
to a noun: if the noun is a cell, it returns the loobean `&` (true); if
|
||||
the noun is an atom, it returns the loobean `|` (false).
|
||||
|
||||
|
@ -3,7 +3,7 @@
|
||||
|
||||
Odored atom
|
||||
|
||||
`dotzay` is a natural hoon that produces a non-cubed atomic constant of
|
||||
`dotzay` is a natural rune that produces a non-cubed atomic constant of
|
||||
odor `p` and value `q`. `dotzay` is never used explicitly, but always
|
||||
implicitly to give odors to atoms.
|
||||
|
||||
|
@ -3,7 +3,7 @@ dotzaz, %dtzz
|
||||
|
||||
Cube
|
||||
|
||||
`dotzaz` is a natural hoon that produces a cubed noun constant of value
|
||||
`dotzaz` is a natural rune that produces a cubed noun constant of value
|
||||
`q` and odor `p`, if `q` is an atom. A cube is an atom whose type
|
||||
contains only itself.
|
||||
|
||||
|
@ -3,7 +3,7 @@ haxgal, `#<`, %hxgl
|
||||
|
||||
Prettyprint `++tape`
|
||||
|
||||
`#<` is a synthetic hoon that slams the gate [`++noah`]() with `p`. `#<`
|
||||
`#<` is a synthetic rune that slams the gate [`++noah`]() with `p`. `#<`
|
||||
is used to produce a [`++tape`]() of the computation passed to it, and
|
||||
is only used in the irregular form.
|
||||
|
||||
|
@ -3,10 +3,10 @@ haxgar, `#>`, %hxgr
|
||||
|
||||
Prettyprint `++tank`
|
||||
|
||||
`#>`, `haxgar`, `[%hxgr p=tusk]`is a synthetic hoon that slams the
|
||||
`#>`, `haxgar`, `[%hxgr p=tusk]`is a synthetic rune that slams the
|
||||
assumed gate `cain` on `[%zpgr %cntr p]`.
|
||||
|
||||
`#>` is a synthetic hoon that slams the gate [`++cain`]() with `p`. `#>`
|
||||
`#>` is a synthetic rune that slams the gate [`++cain`]() with `p`. `#>`
|
||||
is used to produce a [`++tank`]() of the computation passed to it, and
|
||||
is only used in the irregular form.
|
||||
|
||||
|
@ -3,7 +3,7 @@ ketbar, `^|`, %ktbr
|
||||
|
||||
Convert `%gold` to `%iron`
|
||||
|
||||
`^|` is a natural hoon that converts a [`%gold`]() core into an
|
||||
`^|` is a natural rune that converts a [`%gold`]() core into an
|
||||
[`%iron`]() core.
|
||||
|
||||
See also
|
||||
|
@ -3,7 +3,7 @@ ketdot, `^.`, %ktdt
|
||||
|
||||
Cast to product type
|
||||
|
||||
`^.` is a synthetic hoon that casts `q` to the type of `(p q)`. `^.` is
|
||||
`^.` is a synthetic rune that casts `q` to the type of `(p q)`. `^.` is
|
||||
the same as casting `q` to the product type of `p` and comes in handy
|
||||
when you don't want to run the contents of `p`.
|
||||
|
||||
|
@ -3,7 +3,7 @@ kethep, `^-`, %kthp
|
||||
|
||||
Cast to bunt
|
||||
|
||||
`^-` is a synthetic hoon that casts `q` to `~(bunt al p)`, i.e. the icon
|
||||
`^-` is a synthetic rune that casts `q` to `~(bunt al p)`, i.e. the icon
|
||||
of `p`.
|
||||
|
||||
See also
|
||||
|
@ -3,7 +3,7 @@ ketpam, `^&`, %ktpm
|
||||
|
||||
Convert `%gold` to `%zinc`
|
||||
|
||||
`^&` is a natural hoon that converts a `%gold` core into a `%zinc` core.
|
||||
`^&` is a natural rune that converts a `%gold` core into a `%zinc` core.
|
||||
At present, `%zinc` cores are not commonly used.
|
||||
|
||||
See also
|
||||
|
@ -3,7 +3,7 @@ ketsig, `^~`, %ktsg
|
||||
|
||||
Compile statically
|
||||
|
||||
`^~` is a natural hoon that tries to execute `p` statically at compile
|
||||
`^~` is a natural rune that tries to execute `p` statically at compile
|
||||
time; if this fails, `p` remains dynamic. `^~` is primarily useful for
|
||||
optimization, when you know that a value is static, or is most likely
|
||||
static, `^~` can simplify the compilation.
|
||||
|
@ -3,7 +3,7 @@ kettis, `^=`, %ktts
|
||||
|
||||
Wrap
|
||||
|
||||
`^=`, `kettis`, `[%ktts p=toga q=twig]` is a natural hoon that wraps `q`
|
||||
`^=`, `kettis`, `[%ktts p=toga q=twig]` is a natural rune that wraps `q`
|
||||
in the [`++toga`]() `p`. `^=` is most commonly used for assignment,
|
||||
adding one or more names to values.
|
||||
|
||||
|
@ -3,7 +3,7 @@ ketwut, `^?`, %ktwt
|
||||
|
||||
Convert `%gold` to `%lead`
|
||||
|
||||
`^?` is a natural hoon that converts a `%gold` core into a `%lead` core.
|
||||
`^?` is a natural rune that converts a `%gold` core into a `%lead` core.
|
||||
|
||||
See also
|
||||
--------
|
||||
|
@ -3,7 +3,7 @@ sigbar, `~|`, %sgbr
|
||||
|
||||
Add to stacktrace
|
||||
|
||||
`~|` is a synthetic hoon that presents the product of `p` in the stack
|
||||
`~|` is a synthetic rune that presents the product of `p` in the stack
|
||||
trace if `q` crashes. The computation is only performed if needed.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ siglus, `~+`, %sgls
|
||||
|
||||
Memoize
|
||||
|
||||
`~+`, `siglus`, is a synthetic hoon that hints to the interpreter to
|
||||
`~+`, `siglus`, is a synthetic rune that hints to the interpreter to
|
||||
memoize (cache) the computation of `p`.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ sigtis, `~=`, %sgts
|
||||
|
||||
Equality hint
|
||||
|
||||
`~=` is a synthetic hoon that hints to the interpreter that `q` may
|
||||
`~=` is a synthetic rune that hints to the interpreter that `q` may
|
||||
produce a noun equal to the already existing `p`, avoiding duplication.
|
||||
|
||||
Produces
|
||||
|
@ -6,7 +6,7 @@ Apply fold
|
||||
Syntax
|
||||
======
|
||||
|
||||
`;:` is a synthetic hoon that applies `p`, a binary gate, to the n-ary
|
||||
`;:` is a synthetic rune that applies `p`, a binary gate, to the n-ary
|
||||
tuple `q`. `;:` is similar to folding over the tuple `q`, producing the
|
||||
final result.
|
||||
|
||||
|
@ -3,7 +3,7 @@ semsem, `;;`, %smsm
|
||||
|
||||
Fixpoint
|
||||
|
||||
`;;` is a synthetic hoon that types `q` as a fixpoint of `p`. More
|
||||
`;;` is a synthetic rune that types `q` as a fixpoint of `p`. More
|
||||
specifically, `;;` slams `q` through gate `p`, asserting that the
|
||||
resulting noun [`.=`]() the original, and produces it.
|
||||
|
||||
|
@ -3,7 +3,7 @@ semzaz
|
||||
|
||||
`++sail` tag
|
||||
|
||||
`semzaz`, is a virtual hoon frequently referred to as [`++sail`]() in
|
||||
`semzaz`, is a virtual rune frequently referred to as [`++sail`]() in
|
||||
reference to `++sail`:vast which parses it. It is the most basic part of
|
||||
the templating structure frequently used to produce [`++manx`](). In its
|
||||
simplest and most common form we see `semzaz` as
|
||||
|
@ -3,7 +3,7 @@ tisbar, `=|`, %tsbr
|
||||
|
||||
Bunt to subject
|
||||
|
||||
`=|` is a synthetic hoon that pushes the [bunt](), or default value, of
|
||||
`=|` is a synthetic rune that pushes the [bunt](), or default value, of
|
||||
`p` on the subject and sends it to `q`.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ tiscol, `=:`, %tscl
|
||||
|
||||
Batch change subject
|
||||
|
||||
`=:` is a synthetic hoon that produces `q` with the subject modified by
|
||||
`=:` is a synthetic rune that produces `q` with the subject modified by
|
||||
the list of changes in `p` which must be terminated by a `==`. `=:` is
|
||||
useful when you need to make a batch of changes to your subject.
|
||||
|
||||
|
@ -3,7 +3,7 @@ tisdot, `=.`, %tsdt
|
||||
|
||||
Single change subject
|
||||
|
||||
`=.` is a synthetic hoon that produces `r` with `p` in the subject set
|
||||
`=.` is a synthetic rune that produces `r` with `p` in the subject set
|
||||
to `q`.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ tistar, `=*`, %tstr
|
||||
|
||||
Alias
|
||||
|
||||
`=*` is a natural hoon that creates a `%bull`, or alias, type.
|
||||
`=*` is a natural rune that creates a `%bull`, or alias, type.
|
||||
|
||||
Produces
|
||||
--------
|
||||
|
@ -3,7 +3,7 @@ wutbar, `?|`, %wtbr
|
||||
|
||||
OR
|
||||
|
||||
`?|` is a synthetic hoon that computes the "or" of the loobeans in `p`.
|
||||
`?|` is a synthetic rune that computes the "or" of the loobeans in `p`.
|
||||
`?|` is commonly used as a control-flow mechanism.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ wutcol, `?:`, %wtcl
|
||||
|
||||
If, then
|
||||
|
||||
`?:`, `wutcol`, is a natural hoon that produces `q` if `p` is yes (`&`,
|
||||
`?:`, `wutcol`, is a natural rune that produces `q` if `p` is yes (`&`,
|
||||
`0`), or `r` if `p` is no (`|`, 1). `?:` is most similar to the
|
||||
traditional "if" statement, producing the first expression if the
|
||||
loobean is true. `?:` is the inverse of `?.`.
|
||||
|
@ -3,7 +3,7 @@ wutdot, `?.`, %wtdt
|
||||
|
||||
If, else
|
||||
|
||||
`?.`is a synthetic hoon that produces `r` if `p` is yes (`&`, `0`), or
|
||||
`?.`is a synthetic rune that produces `r` if `p` is yes (`&`, `0`), or
|
||||
`q` if `p` is no (`|`, 1). `?.` is sort of like "if not", producing the
|
||||
second expression if the loobean is true. `?.` is the inverse of `?:`.
|
||||
|
||||
|
@ -3,7 +3,7 @@ wutgal, `?<`, %wtgl
|
||||
|
||||
Assert no
|
||||
|
||||
`?<` is a synthetic hoon that produces `q`, asserting that `p` is no
|
||||
`?<` is a synthetic rune that produces `q`, asserting that `p` is no
|
||||
(`|`, 1).
|
||||
|
||||
See also
|
||||
|
@ -3,7 +3,7 @@ wuthep, `?-`, %wthp
|
||||
|
||||
Switch
|
||||
|
||||
`?-` is a synthetic hoon that selects a case in `q` for the value of
|
||||
`?-` is a synthetic rune that selects a case in `q` for the value of
|
||||
`p`. The labels in `q` must match the [icon]() of `p`. The list of
|
||||
cases, `q` must be terminated by `==`.
|
||||
|
||||
|
@ -3,7 +3,7 @@ wuthaz, %wthz
|
||||
|
||||
[Short description]
|
||||
|
||||
`wuthaz`, `[%wthz p=wing q=tine]` is a synthetic hoon that selects a
|
||||
`wuthaz`, `[%wthz p=wing q=tine]` is a synthetic rune that selects a
|
||||
case in `q` for the actual type of `p`.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ wutpam, `?&`, %wtpm
|
||||
|
||||
AND
|
||||
|
||||
`?&` is a synthetic hoon that computes the "and" of the loobeans in `p`.
|
||||
`?&` is a synthetic rune that computes the "and" of the loobeans in `p`.
|
||||
`?&` is commonly used as a control-flow mechanism.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ wuttis, `?=`, %wtts
|
||||
|
||||
Is in tile
|
||||
|
||||
`?=` is a natural hoon that produces true if the leg at wing `q` is in
|
||||
`?=` is a natural rune that produces true if the leg at wing `q` is in
|
||||
tile `p`.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ zapcap, %zpcb
|
||||
|
||||
Path / location trace
|
||||
|
||||
`!_` is a virtual natural hoon that traces the stack if debugging is
|
||||
`!_` is a virtual natural rune that traces the stack if debugging is
|
||||
enabled, putting the current path and location range of each rune.
|
||||
|
||||
Produces
|
||||
|
@ -3,7 +3,7 @@ zaptis, `!=`, %zpts
|
||||
|
||||
Show nock
|
||||
|
||||
`!=` is a natural hoon that produces the formula of twig p as a noun.
|
||||
`!=` is a natural rune that produces the formula of twig p as a noun.
|
||||
|
||||
Produces
|
||||
--------
|
||||
|
Loading…
Reference in New Issue
Block a user