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 * **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.
10 * **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.
11 * **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.
12 * **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.
13 * **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.
14 * **function [noargs](#function-noargs)** - _noargs_ runs all the things against a file and returns as soon as the first func error is found.
15 * **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.
16 * **condition [test-condition](#condition-test-condition)** - Simple documentation.
17 * **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.
19 ## Function **FUNC-THAT-DOES-STUFF**
23 **func-that-does-stuff** _path_ _x_ => _result_
25 ```result::= success-result | failure-result```
26 ```success-result::= (:success filename)```
27 ```failure-result::= (:failure filename msg)```
29 #### Arguments and Values:
32 _x_---a random value related to _path_
33 _filename_---the file this func was run on
34 _msg_---a string containing the failure message
38 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
40 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)
44 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
45 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
47 ## Function **HAS-KEYWORDS**
51 **has-keywords** _path_ _&key_ _x_ => _result_
53 ```result::= success-result | failure-result```
54 ```success-result::= (:success filename)```
55 ```failure-result::= (:failure filename msg)```
57 #### Arguments and Values:
60 _x_---a random value related to _path_
61 _filename_---the file this func was run on
62 _msg_---a string containing the failure message
66 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
68 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)
70 ## Function **HAS-NO-EXAMPLES**
74 **has-no-examples** => _result_
76 ```result::= success-result | failure-result```
77 ```success-result::= (:success filename)```
78 ```failure-result::= (:failure filename msg)```
80 #### Arguments and Values:
82 _filename_---the file this func was run on
83 _msg_---a string containing the failure message
87 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
89 ## Function **HAS-OPTIONAL**
93 **has-optional** _path_ _&optional_ _x_ => _result_
95 ```result::= success-result | failure-result```
96 ```success-result::= (:success filename)```
97 ```failure-result::= (:failure filename msg)```
99 #### Arguments and Values:
102 _x_---a random value related to _path_
103 _filename_---the file this func was run on
104 _msg_---a string containing the failure message
108 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
110 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)
112 ## Function **HAS-REST**
116 **has-rest** _path_ _&rest_ _x_ => _result_
118 ```result::= success-result | failure-result```
119 ```success-result::= (:success filename)```
120 ```failure-result::= (:failure filename msg)```
122 #### Arguments and Values:
125 _x_---a random value related to _path_
126 _filename_---the file this func was run on
127 _msg_---a string containing the failure message
131 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
133 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)
135 ## Function **NOARGS**
139 **noargs** => _result_
141 ```result::= success-result | failure-result```
142 ```success-result::= (:success filename)```
143 ```failure-result::= (:failure filename msg)```
145 #### Arguments and Values:
147 _filename_---the file this func was run on
148 _msg_---a string containing the failure message
152 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
156 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
157 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
159 ## Function **RESULT-LIST**
163 **result-list** => _result_
165 ```result::= failure-result*```
166 ```failure-result::= (:failure filename msg)```
168 #### Arguments and Values:
170 _filename_---the file this func was run on
171 _msg_---a string containing the failure message
175 _result-list_ runs all the things against a file and returns as soon as the first func error is found.
177 ## Condition TEST-CONDITION
179 Simple documentation.
181 For a simple condition.
183 ## Function **VALUES-RESULT**
187 **values-result** => _result1_, _result2_, _result3_
189 ```result1::= success-result | failure-result```
190 ```success-result::= (:success filename)```
191 ```failure-result::= (:failure filename msg)```
193 #### Arguments and Values:
195 _result2_---second result
196 _result3_---third result
197 _filename_---the file this func was run on
198 _msg_---a string containing the failure message
202 _values-result_ runs all the things against a file and returns as soon as the first func error is found.