on master help sign in
minor changes, rune pages added
commit70c644b72174875d74f12923e731c1859761a42e authorjoshuareagan <josh@tlon.io> dateMon 15 Oct 2018, 13:57 (8 years ago) parent477ed06
5 files changed+114−1
docs/reference/rune/col/col.udon+25 docs/reference/rune/lus/tar.hoon → docs/reference/rune/lus/tar.udon docs/reference/rune/sig.udon+1−1 docs/reference/rune/zap/col.udon+38 docs/reference/rune/zap/dot.udon+50
docs/reference/rune/col/col.udonnew file+25
@@ -0,0 +1,25 @@
1+:- :~ navhome/'/docs/'
2+ next/'true'
3+ sort/'7'
4+ title/':: "colcol"'
5+ ==
6+;>
7+
8+# `:: "colcol"`
9+
10+Code comment
11+
12+### Syntax
13+
14+:: any text you like!
15+
16+### Examples
17+
18+```
19+::
20+:: this is commented code
21+::
22+|= a=@ :: a gate
23+(add 2 a) :: that adds 2
24+ :: to the input
25+```
docs/reference/rune/lus/tar.hoon → docs/reference/rune/lus/tar.udonrenamed

The content is the same.

docs/reference/rune/sig.udon+1−1
@@ -7,7 +7,7 @@
77
88# Hints `~` ("sig")
99
10−Runes that use Nock `10` to pass non-semantic info to the interpreter.
10+Runes that use Nock `11` to pass non-semantic info to the interpreter.
1111
1212## Runes
1313
docs/reference/rune/zap/col.udonnew file+38
@@ -0,0 +1,38 @@
1+:- :~ navhome/'/docs/'
2+ next/'true'
3+ sort/'5'
4+ title/'!: "zapcol"'
5+ ==
6+;>
7+
8+# `!: "zapcol"`
9+
10+`[%dbug p=hoon]`: turn on stack trace
11+
12+## Produces
13+
14+The product of `p` unless `p` crashes, in which case a stack trace is given.
15+
16+## Syntax
17+
18+Regular: *1-fixed*.
19+
20+```
21+!: p=hoon
22+```
23+
24+## Discussion
25+
26+`!:` is used to turn on a debugging stack trace option for any code you have in `p`.
27+
28+## Examples
29+
30+```
31+> ?:(=(0 1) 123 !!)
32+ford: %ride failed to execute:
33+
34+> !: ?:(=(0 1) 123 !!)
35+/~zod/home/~2018.10.15..19.50.06..74af:<[1 5].[1 22]>
36+/~zod/home/~2018.10.15..19.50.06..74af:<[1 19].[1 21]>
37+ford: %ride failed to execute:
38+```
docs/reference/rune/zap/dot.udonnew file+50
@@ -0,0 +1,50 @@
1+:- :~ navhome/'/docs/'
2+ next/'true'
3+ sort/'6'
4+ title/'!. "zapdot"'
5+ ==
6+;>
7+
8+# `!. "zapdot"`
9+
10+turn on stack trace for a subexpression `p`
11+
12+## Produces
13+
14+The product of `p`. If `p` crashes, no stack trace entries are given for that code.
15+
16+## Syntax
17+
18+Regular: *1-fixed*.
19+
20+```
21+!. p=hoon
22+```
23+
24+`p` is any Hoon expression.
25+
26+## Discussion
27+
28+`!.` is used to turn off a debugging stack trace option for any code you have in `p`. This rune can be embedded under a `!:` rune for inner loops of your code that you don't want or need to trace. This is especially useful if a trace overflows the stack.
29+
30+## Examples
31+
32+```
33+> %.(1 |=(a=@ ^-(@ ?:(=(a 10) !! $(a +(a))))))
34+ford: %ride failed to execute:
35+
36+> !: %.(1 |=(a=@ ^-(@ ?:(=(a 10) !! $(a +(a))))))
37+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 5].[1 49]>
38+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 17].[1 47]>
39+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 22].[1 46]>
40+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 36].[1 45]>
41+...skipping some lines...
42+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 17].[1 47]>
43+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 22].[1 46]>
44+/~zod/home/~2018.10.15..20.01.21..6b0c:<[1 33].[1 35]>
45+ford: %ride failed to execute:
46+
47+> !: %.(1 !.(|=(a=@ ^-(@ ?:(=(a 10) !! $(a +(a)))))))
48+/~zod/home/~2018.10.15..20.01.35..0529:<[1 5].[1 53]>
49+ford: %ride failed to execute:
50+```