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 [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.
16 * **function [noargs](#function-noargs)** - _noargs_ runs all the things against a file and returns as soon as the first func error is found.
17 * **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.
18 * **condition [test-condition](#condition-test-condition)** - Simple documentation.
19 * **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.
21 ## Variable \*SPECIAL\-VARIABLE\*
33 It is special, and a boolean.
35 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.
39 ```(let ((*special-variable* t)) (go))``` => ```'let-it-go```
41 ## Function **FUNC-THAT-DOES-STUFF**
45 **func-that-does-stuff** _path_ _x_ => _result_
47 ```result::= success-result | failure-result```
48 ```success-result::= (:success filename)```
49 ```failure-result::= (:failure filename msg)```
51 #### Arguments and Values:
54 _x_---a random value related to _path_
55 _filename_---the file this func was run on
56 _msg_---a string containing the failure message
60 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
62 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)
66 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
67 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
69 ## Function **HAS-KEYWORDS**
73 **has-keywords** _path_ _&key_ _x_ => _result_
75 ```result::= success-result | failure-result```
76 ```success-result::= (:success filename)```
77 ```failure-result::= (:failure filename msg)```
79 #### Arguments and Values:
82 _x_---a random value related to _path_
83 _filename_---the file this func was run on
84 _msg_---a string containing the failure message
88 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
90 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)
92 ## Function **HAS-NO-EXAMPLES**
96 **has-no-examples** => _result_
98 ```result::= success-result | failure-result```
99 ```success-result::= (:success filename)```
100 ```failure-result::= (:failure filename msg)```
102 #### Arguments and Values:
104 _filename_---the file this func was run on
105 _msg_---a string containing the failure message
109 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
111 ## Function **HAS-OPTIONAL**
115 **has-optional** _path_ _&optional_ _x_ => _result_
117 ```result::= success-result | failure-result```
118 ```success-result::= (:success filename)```
119 ```failure-result::= (:failure filename msg)```
121 #### Arguments and Values:
124 _x_---a random value related to _path_
125 _filename_---the file this func was run on
126 _msg_---a string containing the failure message
130 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
132 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)
134 ## Function **HAS-REST**
138 **has-rest** _path_ _&rest_ _x_ => _result_
140 ```result::= success-result | failure-result```
141 ```success-result::= (:success filename)```
142 ```failure-result::= (:failure filename msg)```
144 #### Arguments and Values:
147 _x_---a random value related to _path_
148 _filename_---the file this func was run on
149 _msg_---a string containing the failure message
153 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
155 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)
157 ## Function **NO-ARGS-AND-VALUES**
161 **no-args-and-values** => _result_
163 ```result::= :nothing```
167 _result_-LIST runs all the things against a file and returns as soon as the first func error is found.
169 ## Function **NOARGS**
173 **noargs** => _result_
175 ```result::= success-result | failure-result```
176 ```success-result::= (:success filename)```
177 ```failure-result::= (:failure filename msg)```
179 #### Arguments and Values:
181 _filename_---the file this func was run on
182 _msg_---a string containing the failure message
186 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
190 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
191 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
193 ## Function **RESULT-LIST**
197 **result-list** => _result_
199 ```result::= failure-result*```
200 ```failure-result::= (:failure filename msg)```
202 #### Arguments and Values:
204 _filename_---the file this func was run on
205 _msg_---a string containing the failure message
209 _result-list_ runs all the things against a file and returns as soon as the first func error is found.
211 ## Condition TEST-CONDITION
213 Simple documentation.
215 For a simple condition.
217 ## Function **VALUES-RESULT**
221 **values-result** => _result1_, _result2_, _result3_
223 ```result1::= success-result | failure-result```
224 ```success-result::= (:success filename)```
225 ```failure-result::= (:failure filename msg)```
227 #### Arguments and Values:
229 _result2_---second result
230 _result3_---third result
231 _filename_---the file this func was run on
232 _msg_---a string containing the failure message
236 _values-result_ runs all the things against a file and returns as soon as the first func error is found.