3 This defines a simple successful package.
5 This is should all get pulled in and the markdown.md should be equal to success1.md.
9 * **variable [\*special\-variable\*](#variable-special-variable)** - It is special, and a boolean.
10 * **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.
11 * **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.
12 * **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.
13 * **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.
14 * **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.
15 * **function [noargs](#function-noargs)** - _noargs_ runs all the things against a file and returns as soon as the first func error is found.
16 * **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.
17 * **condition [test-condition](#condition-test-condition)** - Simple documentation.
18 * **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.
20 ## Variable \*SPECIAL\-VARIABLE\*
32 It is special, and a boolean.
34 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.
38 ```(let ((*special-variable* t)) (go))``` => ```'let-it-go```
40 ## Function **FUNC-THAT-DOES-STUFF**
44 **func-that-does-stuff** _path_ _x_ => _result_
46 ```result::= success-result | failure-result```
47 ```success-result::= (:success filename)```
48 ```failure-result::= (:failure filename msg)```
50 #### Arguments and Values:
53 _x_---a random value related to _path_
54 _filename_---the file this func was run on
55 _msg_---a string containing the failure message
59 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
61 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)
65 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
66 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
68 ## Function **HAS-KEYWORDS**
72 **has-keywords** _path_ _&key_ _x_ => _result_
74 ```result::= success-result | failure-result```
75 ```success-result::= (:success filename)```
76 ```failure-result::= (:failure filename msg)```
78 #### Arguments and Values:
81 _x_---a random value related to _path_
82 _filename_---the file this func was run on
83 _msg_---a string containing the failure message
87 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
89 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)
91 ## Function **HAS-NO-EXAMPLES**
95 **has-no-examples** => _result_
97 ```result::= success-result | failure-result```
98 ```success-result::= (:success filename)```
99 ```failure-result::= (:failure filename msg)```
101 #### Arguments and Values:
103 _filename_---the file this func was run on
104 _msg_---a string containing the failure message
108 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
110 ## Function **HAS-OPTIONAL**
114 **has-optional** _path_ _&optional_ _x_ => _result_
116 ```result::= success-result | failure-result```
117 ```success-result::= (:success filename)```
118 ```failure-result::= (:failure filename msg)```
120 #### Arguments and Values:
123 _x_---a random value related to _path_
124 _filename_---the file this func was run on
125 _msg_---a string containing the failure message
129 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
131 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)
133 ## Function **HAS-REST**
137 **has-rest** _path_ _&rest_ _x_ => _result_
139 ```result::= success-result | failure-result```
140 ```success-result::= (:success filename)```
141 ```failure-result::= (:failure filename msg)```
143 #### Arguments and Values:
146 _x_---a random value related to _path_
147 _filename_---the file this func was run on
148 _msg_---a string containing the failure message
152 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
154 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)
156 ## Function **NOARGS**
160 **noargs** => _result_
162 ```result::= success-result | failure-result```
163 ```success-result::= (:success filename)```
164 ```failure-result::= (:failure filename msg)```
166 #### Arguments and Values:
168 _filename_---the file this func was run on
169 _msg_---a string containing the failure message
173 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
177 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
178 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
180 ## Function **RESULT-LIST**
184 **result-list** => _result_
186 ```result::= failure-result*```
187 ```failure-result::= (:failure filename msg)```
189 #### Arguments and Values:
191 _filename_---the file this func was run on
192 _msg_---a string containing the failure message
196 _result-list_ runs all the things against a file and returns as soon as the first func error is found.
198 ## Condition TEST-CONDITION
200 Simple documentation.
202 For a simple condition.
204 ## Function **VALUES-RESULT**
208 **values-result** => _result1_, _result2_, _result3_
210 ```result1::= success-result | failure-result```
211 ```success-result::= (:success filename)```
212 ```failure-result::= (:failure filename msg)```
214 #### Arguments and Values:
216 _result2_---second result
217 _result3_---third result
218 _filename_---the file this func was run on
219 _msg_---a string containing the failure message
223 _values-result_ runs all the things against a file and returns as soon as the first func error is found.