Add variable documentation

[sheep] / resources / success1.md

diff --git a/resources/success1.md b/resources/success1.md
index f0bf81d29f40ac795351dba5c0d97445644a0639..80c3c1ce406030bd17769fecaf1a694b8371375e 100644 (file)
--- a/resources/success1.md
+++ b/resources/success1.md
@@ -6,6 +6,7 @@ This is should all get pulled in and the markdown.md should be equal to success1
 
 ## Contents
 
 
 ## 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 [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.


@@ -16,6 +17,26 @@ This is should all get pulled in and the markdown.md should be equal to success1
 * **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.
 
 * **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: