urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2025-01-07 13:37:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

Now with minimal arm documentation.

Browse Source
This commit is contained in:
Elliot Glaysher 2017-05-24 21:32:50 -07:00
parent de2ed36fbe
commit 45cb25f0dd
1 changed files with 47 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
app/dojo.hoon
View File

@ -598,8 +598,8 @@
$: $arm $: $arm
name/tape name/tape
docs/what docs/what
f/foot
r/span r/span
con/coil
== ==
:> inspecting a single chapter on a core. :> inspecting a single chapter on a core.
$: $chapter $: $chapter
@ -648,12 +648,12 @@
$(sut p.sut) $(sut p.sut)
?~ (find `(list term)`[i.topics ~] p.core-docs) ?~ (find `(list term)`[i.topics ~] p.core-docs)
:: the current topic isn't the toplevel core topic. :: the current topic isn't the toplevel core topic.
=+ arm-docs=(find-arm-in-coil i.topics q.sut) =+ arm=(find-arm-in-coil i.topics q.sut)
?~ arm-docs ?~ arm
:: the current topic is neither the name of the core or an arm :: the current topic is neither the name of the core or an arm
:: on the core. :: on the core.
$(sut p.sut) $(sut p.sut)
`[%arm (trip i.topics) u.arm-docs p.sut q.sut] `[%arm (trip i.topics) p.u.arm q.u.arm p.sut]
?~ t.topics ?~ t.topics
:: we matched the core name and have no further search terms. :: we matched the core name and have no further search terms.
=* compiled-against (build-inspectable-recursively p.sut) =* compiled-against (build-inspectable-recursively p.sut)
@ -790,7 +790,7 @@
:> if {arm-name} is an arm in {c}, returns its documentation. :> if {arm-name} is an arm in {c}, returns its documentation.
++ find-arm-in-coil ++ find-arm-in-coil
|= {arm-name/term con/coil} |= {arm-name/term con/coil}
^- (unit what) ^- (unit (pair what foot))
=/ tombs (~(tap by q.s.con)) =/ tombs (~(tap by q.s.con))
|- |-
?~ tombs ?~ tombs
@ -798,7 +798,7 @@
=+ item=(~(get by q.q.i.tombs) arm-name) =+ item=(~(get by q.q.i.tombs) arm-name)
?~ item ?~ item
$(tombs t.tombs) $(tombs t.tombs)
[~ p.u.item] [~ u.item]
:: ::
:> returns an overview for a core's arms and chapters. :> returns an overview for a core's arms and chapters.
:> :>
@ -891,23 +891,42 @@
:: ::
:> renders the documentation for a single arm in a core. :> renders the documentation for a single arm in a core.
++ print-arm ++ print-arm
|= {arm-name/tape doc/what r/span con/coil} |= {arm-name/tape doc/what f/foot sut/span}
:: todo: use the coil to figure out what this arm is. :: ok, so i misunderstood how this works. in case of something like a
?~ doc :: constant:
`tang`[%leaf "{arm-name}: (Undocumented)"]~ ::
:: ++ forty-two
:: :> the answer
:: 42
::
:: the %help never shows up in the span.
::
:: todo: need to get the sample here. also hoist this to the general
:: core printing machinery, too.
=/ foot-span (~(play ut sut) p.f)
:: ~& [%foot-span foot-span]
=/ product/what
?+ foot-span ~
{$help *} p.foot-span
{$core *} q.r.q.foot-span
==
%+ weld %+ weld
`tang`[%leaf "{arm-name}: {(trip p.u.doc)}"]~ (print-header [arm-name ~] doc)
(print-sections q.u.doc) ?~ product
~
%+ weld
`tang`[[%leaf ""] [%leaf "product:"] ~]
(print-header ~ product)
:: ::
:> renders the documentation for a chapter in a core. :> renders the documentation for a chapter in a core.
++ print-chapter ++ print-chapter
|= {name/tape docs/what con/coil chapter-id/@} |= {name/tape doc/what con/coil chapter-id/@}
;: weld ;: weld
`tang`[%leaf name]~ (print-header [name ~] doc)
:: ::
?~ docs ?~ doc
~ ~
(print-sections q.u.docs) (print-sections q.u.doc)
:: ::
=+ arms=(arms-in-chapter con chapter-id) =+ arms=(arms-in-chapter con chapter-id)
?~ arms ?~ arms
@ -917,9 +936,9 @@
:: ::
:> renders the documentation for a face. :> renders the documentation for a face.
++ print-face ++ print-face
|= {name/tape docs/what children/(unit item)} |= {name/tape doc/what children/(unit item)}
%+ weld %+ weld
(print-header [name ~] docs) (print-header [name ~] doc)
?~ children ?~ children
~ ~
(print-item u.children) (print-item u.children)
@ -927,19 +946,19 @@
:> returns a set of lines from a {chap} :> returns a set of lines from a {chap}
++ print-header ++ print-header
:: todo: it's weird that (list tape) is the type used for names. :: todo: it's weird that (list tape) is the type used for names.
|= {p/(list tape) docs/what} |= {p/(list tape) doc/what}
^- tang ^- tang
?~ p ?~ p
?~ docs ?~ doc
[%leaf "(Undocumented)"]~ [%leaf "(Undocumented)"]~
%+ weld %+ weld
`tang`[%leaf "{(trip p.u.docs)}"]~ `tang`[%leaf "{(trip p.u.doc)}"]~
(print-sections q.u.docs) (print-sections q.u.doc)
?~ docs ?~ doc
[%leaf "{i.p}"]~ [%leaf "{i.p}"]~
%+ weld %+ weld
`tang`[%leaf "{i.p}: {(trip p.u.docs)}"]~ `tang`[%leaf "{i.p}: {(trip p.u.doc)}"]~
(print-sections q.u.docs) (print-sections q.u.doc)
:: ::
:> renders an overview as {tang} :> renders an overview as {tang}
++ print-overview ++ print-overview
@ -991,7 +1010,7 @@
:: ::
:> renders a single item line with the given indentation level. :> renders a single item line with the given indentation level.
++ render-item ++ render-item
|= {indentation/@u max-key-length/@u name/tape docs/what} |= {indentation/@u max-key-length/@u name/tape doc/what}
^- tang ^- tang
=+ spaces=(mul indentation 2) =+ spaces=(mul indentation 2)
=+ line=(weld (dy-build-space spaces) name) =+ line=(weld (dy-build-space spaces) name)
@ -1001,9 +1020,9 @@
=? line (gth diff 0) =? line (gth diff 0)
(weld line (dy-build-space diff)) (weld line (dy-build-space diff))
=/ slogan/tape =/ slogan/tape
?~ docs ?~ doc
~ ~
(trip p.u.docs) (trip p.u.doc)
=? line !=(0 (lent slogan)) =? line !=(0 (lent slogan))
;: weld ;: weld
line line