urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-12-19 16:51:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

doccords: deco convention for +$ arms

Browse Source
This commit is contained in:
drbeefsupreme 2022-07-06 18:22:21 -04:00
parent ef9297cfd7
commit 73c0222d2e
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pkg/arvo/lib/deco.hoon
View File

@ -70,12 +70,14 @@
:>
:> a postfix formal comment will either attach to hoon or spec on the
:> current line, or the arm name if there is no hoon or spec on the
:> line
:> line. the convention for +$ arms is that the comment attached to the
:> arm is about the mold itself, while the comment attached to the spec
:> is about the output type of the mold.
:>
:> |% and |@ cores can be given @tas names with e.g. `|% %foo`. for
:> now, the only purpose of this is to make cores not built by arms
:> legible to doccords. in order to name any other core type, you will
:> need to desugar it for now.
:> more legible to doccords users. in order to name any other core type,
:> you will need to desugar it by hand for the time being.
:>
:> to inspect doccords in this file from dojo, try the following:
:>
@ -98,7 +100,7 @@
:> functions), mold builders (functions that build molds), and
:> constants (static data).
:>
:> most code will not need its own patterns. but put them
:> most code will not need its own mold builders. but put them
:> in a separate chapter (separated by {+|}).
|% %arch
:> molds are functions that normalize nouns.