tools.scaffold vocabulary
Factor handbook » Vocabulary index

Documentation
Scaffold tool

Metadata

Parents:	tools
Authors:	Doug Coleman

Words

Tuple classes

Class	Superclass	Slots
not-a-vocab-root	tuple	string
vocab-must-not-exist	tuple	string

Generic words

Word	Stack effect
scaffold-docs	( obj -- )
scaffold-emacs	( -- )

Symbol words

developer-name

nested-examples

using

Ordinary words

Word	Stack effect
delete-from-root-cache	( string -- )
example-using	( using -- )
help.	( word -- )
make-unit-test	( answer code -- str )
n-examples-using	( n using -- )
not-a-vocab-root	( string -- * )
read-unit-test	( -- str/f )
read-unit-tests	( -- str )
run-string	( string -- datastack )
scaffold-authors	( vocab -- )
scaffold-basis	( string -- )
scaffold-core	( string -- )
scaffold-examples	( word -- )
scaffold-extra	( string -- )
scaffold-factor-boot-rc	( -- )
scaffold-factor-rc	( -- )
scaffold-factor-roots	( -- )
scaffold-file	( path -- )
scaffold-mason-rc	( -- )
scaffold-n-examples	( n word -- )
scaffold-platforms	( vocab platforms -- )
scaffold-rc	( path -- )
scaffold-summary	( vocab summary -- )
scaffold-tags	( vocab tags -- )
scaffold-tests	( vocab -- )
scaffold-undocumented	( string -- )
scaffold-unit-tests	( vocab -- )
scaffold-vocab	( string -- )
scaffold-vocab-in	( vocab-root string -- )
scaffold-word-docs	( word -- )
scaffold-work	( string -- )
vocab-must-not-exist	( string -- * )

Class predicate words

Word	Stack effect
not-a-vocab-root?	( object -- ? )
vocab-must-not-exist?	( object -- ? )

Files

resource:basis/tools/scaffold/scaffold.factor
resource:basis/tools/scaffold/scaffold-docs.factor
resource:basis/tools/scaffold/scaffold-tests.factor

Metadata files

resource:basis/tools/scaffold/authors.txt
resource:basis/tools/scaffold/summary.txt

Children from resource:basis

Vocabulary	Summary
tools.scaffold.windows