on master help sign in
Straighten out the Accepts and Produces sections of docs/hoon/library/4m.md (with help from ~master-morzod).
commit77984048a70d112604f9f1805ed83387780ea987 authorJohn Franklin <jfranklin9000@gmail.com> dateMon 12 Feb 2018, 10:10 (9 years ago) parent1e0ba21
1 file changed+48−25
docs/hoon/library/4m.md+48−25
docs/hoon/library/4m.md+48−25
@@ -13,10 +13,12 @@ Renders a dime `mol` as a cord.
1313Accepts
1414-------
1515
16+`mol` is a `++dime`.
17+
1618Produces
1719--------
1820
19−`mol` is a `++dime`.
21+A `cord`.
2022
2123Source
2224------
@@ -50,15 +52,17 @@ Examples
5052
5153Render dime as tape
5254
53−Renders `mol` as a tape.
55+Renders a dime `mol` as a tape.
5456
5557Accepts
5658-------
5759
60+`mol` is a `++dime`.
61+
5862Produces
5963--------
6064
61−`mol` is a `++dime`.
65+A `tape`.
6266
6367Source
6468------
@@ -90,12 +94,14 @@ odor specified by `mod`.
9094Accepts
9195-------
9296
97+`mod` is a term, an atom of odor `@tas`.
98+
99+`txt` is a cord, an atom of odor `@ta`.
100+
93101Produces
94102--------
95103
96−`mod` is a term, an atom of odor `@tas`.
97−
98−`txt` is a span, an atom of odor `@ta`.
104+A `gate`.
99105
100106Source
101107------
@@ -119,20 +125,22 @@ Examples
119125***
120126### `++slav`
121127
122−Demand: parse span with input odor
128+Demand: parse cord with input odor
123129
124−Parses a span `txt` to an atom of the odor specificed by `mod`. Crashes
125−if it failes to parse.
130+Parses a cord `txt` to an atom of the odor specificed by `mod`.
131+Crashes if it fails to parse.
126132
127133Accepts
128134-------
129135
136+`mod` is a term, an atom of odor `@tas`.
137+
138+`txt` is a cord, an atom of odor `@ta`.
139+
130140Produces
131141--------
132142
133−`mod` is a term, an atom of odor `@tas`.
134−
135−`txt` is a span, an atom of odor `@ta`.
143+The atom of a `(unit @)` from `++slaw`, or crash.
136144
137145Source
138146------
@@ -164,19 +172,21 @@ Examples
164172***
165173### `++slaw`
166174
167−Parse span to input odor
175+Parse cord to input odor
168176
169−Parses a span `txt` to an atom of the odor specified by `mod`.
177+Parses a cord `txt` to an atom of the odor specified by `mod`.
170178
171179Accepts
172180-------
173181
182+`mod` is a term, an atom of odor `@tas`.
183+
184+`txt` is a cord, an atom of odor `@ta`.
185+
174186Produces
175187--------
176188
177−`mod` is a term, an atom of odor `@tas`.
178−
179−`txt` is a span, an atom of odor `@ta`.
189+A `(unit @)`.
180190
181191Source
182192------
@@ -214,17 +224,19 @@ Examples
214224***
215225### `++slay`
216226
217−Parse span to coin
227+Parse cord to coin
218228
219−Parses a span `txt` to the unit of a `++coin`.
229+Parses a cord `txt` to the unit of a `++coin`.
220230
221231Accepts
222232-------
223233
234+`txt` is a `@ta`.
235+
224236Produces
225237--------
226238
227−`txt` is a `@ta`.
239+A `(unit coin)`.
228240
229241Source
230242------
@@ -282,10 +294,12 @@ pretty-printing.
282294Accepts
283295-------
284296
297+`bon` is a `++path`.
298+
285299Produces
286300--------
287301
288−`bon` is a `++path`.
302+A `tank`.
289303
290304Source
291305------
@@ -326,10 +340,12 @@ Renders a path `pax` as cord.
326340Accepts
327341-------
328342
343+`pax` is a `path`.
344+
329345Produces
330346--------
331347
332−`pax` is a `path`.
348+A `cord`.
333349
334350Source
335351------
@@ -358,10 +374,12 @@ Renders a path `pax` as tape.
358374Accepts
359375-------
360376
377+`pax` is a `path`.
378+
361379Produces
362380--------
363381
364−`pax` is a `path`.
382+A `tape`.
365383
366384Source
367385------
@@ -383,16 +401,21 @@ Examples
383401***
384402### `++stab`
385403
386−Parse span to path
404+Parse cord to path
387405
388−Parsing rule. Parses a span `zep` to a static `++path`.
406+Parsing rule. Parses a cord `zep` to a static `++path`.
407+Crashes if it fails to parse.
389408
390409Accepts
391410-------
392411
412+`zep` is a `@t`.
413+
393414Produces
394415--------
395416
417+A `path`, or crash.
418+
396419Source
397420------
398421