Remove need for ARGUMENTS AND VALUES when there are none
[sheep] / resources / success1.md
index f0bf81d29f40ac795351dba5c0d97445644a0639..3c4b4f833c800e8857609690b098cb77603a588b 100644 (file)
@@ -6,16 +6,38 @@ This is should all get pulled in and the markdown.md should be equal to success1
 
 ## 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 [no-args-and-values](#function-no-args-and-values)** - _result_-LIST 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:
@@ -132,6 +154,18 @@ _has-rest_ runs all the things against a file and returns as soon as the first f
 
 This second section uses _path_ and _x_ as something we should talk about, but doesn't use all the arguments (let's include _path_ here for fun)
 
+## Function **NO-ARGS-AND-VALUES**
+
+#### Syntax:
+
+**no-args-and-values** => _result_
+
+```result::= :nothing```  
+
+#### Description:
+
+_result_-LIST runs all the things against a file and returns as soon as the first func error is found.
+
 ## Function **NOARGS**
 
 #### Syntax: