Commits

crcx committed 5f50b5c Draft

add docstrings for vocabularies; vector? should be hidden now

Comments (0)

Files changed (3)

doc/Function_List.md

 Allow direct access to functions in a chain
 
 ## strings'
-undocumented
+
+    ( - )
+
+vocabulary with functions for dealing with strings
 
 ## buffer'
-undocumented
+
+    ( - )
+
+vocabulary for dealing with LIFO buffers
 
 ## internals'
-undocumented
+
+    ( - )
+
+vocabulary containing functions used internally by Retro
 
 ## variables|
 
 w: ]] ]] compiler # on ;
 "( - ) Turn compiler on" :doc
 
-w: vector? vector?  vector # @, 0; drop, 0 # , 0 # , ;
-"( - ) NEEDS-DESCRIPTION" :doc
+i: vector?  vector # @, 0; drop, 0 # , 0 # , ;
 
 w: : :   create ' .word # last # @, d->class !, ]] vector? ;
 "( ``- ) Calls **create**, changes class to **.word**, and turns **compiler** on." :doc
   &string create string @last !d->xt &.word reclass
   "( -a ) Helper function for strings" :doc
 ;chain
+"( - ) vocabulary containing functions used internally by Retro" :doc
 
 hide string
 hide quote
   "( a- ) Set buffer to memory address and empty it" :doc
 }}
 ;chain
+"( - ) vocabulary for dealing with LIFO buffers" :doc
 
 ( Text Strings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ )
 with buffer'
   "( $``-$$ ) Parse for a character and call **splitAtChar**" :doc
 ;chain
 without
+"( - ) vocabulary with functions for dealing with strings" :doc
 
 ( Access Words Within Chains Directly ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ )
 with strings'
   3 constant LIST   ( -n )
   "( -n ) Type constant for linked lists" :doc
 ;chain
-
+"( - ) vocabulary with constants for data types. Used with **each@**" :doc
 
 : describe
   d' 0; dup d->doc @ swap d->class @ xt->d d->name "\nclass: %s\n%s\n" puts ;
Binary file modified.