hoon: add +$  cuff  (list link)
makes doccords stuff more readable. also changes the (list link) in
$help to cuff
[%gate p=term] :: =gate
[%path p=term] :: /path
== ::
++$ cuff (list link) :: parsed lex segments
+$ crib [summary=cord details=(list sect)] ::
-+$ help [links=(list link) =crib] :: documentation
++$ help [=cuff =crib] :: documentation
+$ limb $@ term :: wing element
$% [%& p=axis] :: by geometry
[%| p=@ud q=(unit term)] :: by name
+$ vair ?(%gold %iron %lead %zinc) :: in/contra/bi/co
+$ vein (list (unit axis)) :: search trace
+$ sect (list pica) :: paragraph
-+$ whit
- $: bat=(map (list link) (pair cord (list sect))) :: batch comments
- use=(set (list link)) :: defs used
++$ whit :: doccords parse
+ $: bat=(map cuff (pair cord (list sect))) :: batch comments
+ use=(set cuff) :: defs used
== ::
+$ what (unit (pair cord (list sect))) :: help slogan/section
+$ wing (list limb) :: search path
::
++ lore
%+ cook
- |= [[a=(list link) b=cord] c=(list sect) d=(unit ~)]
+ |= [[a=cuff b=cord] c=(list sect) d=(unit ~)]
[a b c]
;~(pose smol larg)
::
- :: +smol: doccords parser, consumes two aces and a nonempty (list link)
+ :: +smol: doccords parser, consumes two aces and a nonempty $cuff
::
:: only for one-liner comments to be attached to the given link
++ smol
:: +larg: annotates for four aces, optional link
::
:: four aces without a link means this is a short or long comment to be attached
- :: to the following $hoon or $spec. a (list link) means this is a potentially
+ :: to the following $hoon or $spec. a nonempty cuff means this is a potentially
:: long form batch comment
++ larg
;~ plug
++ deep
;~ pose
(inlo dibs)
- (cold *(list link) ;~(plug col gar step step))
+ (cold *cuff ;~(plug col gar step step))
==
::
++ rant
?~ duds nude
:: if there is no link, its not part of a batch comment
::
- ?~ links.i.duds
+ ?~ cuff.i.duds
$(duds t.duds)
:: we don't look past the first link for the initial release of doccords
::
=/ nom=(unit term)
- ?+ i.links.i.duds ~
+ ?+ i.cuff.i.duds ~
:: we only support ++ and +$ batch comments in this release
::
?([%funk *] [%plan *])
- `p.i.links.i.duds
+ `p.i.cuff.i.duds
==
%= $
duds t.duds
