Add variable documentation

[sheep] / resources / success1.md

diff --git a/resources/success1.md b/resources/success1.md
index c3a91d1b82072f2ee7488d8dfbece2653a74ecb1..80c3c1ce406030bd17769fecaf1a694b8371375e 100644 (file)
--- a/resources/success1.md
+++ b/resources/success1.md
@@ -4,6 +4,39 @@ This defines a simple successful package.
 
 This is should all get pulled in and the markdown.md should be equal to success1.md.
 
 
 This is should all get pulled in and the markdown.md should be equal to success1.md.
 

+## Contents
+
+* **variable [\*special\-variable\*](#variable-special-variable)** - It is special, and a boolean.
+* **function [func-that-does-stuff](#function-func-that-does-stuff)** - _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
+* **function [has-keywords](#function-has-keywords)** - _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
+* **function [has-no-examples](#function-has-no-examples)** - _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
+* **function [has-optional](#function-has-optional)** - _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
+* **function [has-rest](#function-has-rest)** - _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
+* **function [noargs](#function-noargs)** - _noargs_ runs all the things against a file and returns as soon as the first func error is found.
+* **function [result-list](#function-result-list)** - _result-list_ runs all the things against a file and returns as soon as the first func error is found.
+* **condition [test-condition](#condition-test-condition)** - Simple documentation.
+* **function [values-result](#function-values-result)** - _values-result_ runs all the things against a file and returns as soon as the first func error is found.
+
+## Variable \*SPECIAL\-VARIABLE\*
+
+#### Value Type:
+
+a generalized boolean
+
+#### Initial Value:
+
+NIL
+
+#### Description:
+
+It is special, and a boolean.
+
+When true, it satisfies if coniditions.  When NIL, it does not. That may make it seem like it's not very special, but it is.
+
+#### Examples:
+
+```(let ((*special-variable* t)) (go))``` => ```'let-it-go```  
+

 ## Function **FUNC-THAT-DOES-STUFF**
 
 #### Syntax:
 ## Function **FUNC-THAT-DOES-STUFF**
 
 #### Syntax:


@@ -160,7 +193,7 @@ _msg_---a string containing the failure message
 
 #### Description:
 
 
 #### Description:
 

-NOARGS runs all the things against a file and returns as soon as the first func error is found.
+_result-list_ runs all the things against a file and returns as soon as the first func error is found.

 
 ## Condition TEST-CONDITION
 
 
 ## Condition TEST-CONDITION