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.
7 ## Function **FUNC-THAT-DOES-STUFF**
11 **func-that-does-stuff** _path_ _x_ => _result_
13 ```result::= success-result | failure-result```
14 ```success-result::= (:success filename)```
15 ```failure-result::= (:failure filename msg)```
17 #### Arguments and Values:
20 _x_---a random value related to _path_
21 _filename_---the file this func was run on
22 _msg_---a string containing the failure message
26 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
28 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)
32 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
33 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
35 ## Function **HAS-KEYWORDS**
39 **has-keywords** _path_ _&key_ _x_ => _result_
41 ```result::= success-result | failure-result```
42 ```success-result::= (:success filename)```
43 ```failure-result::= (:failure filename msg)```
45 #### Arguments and Values:
48 _x_---a random value related to _path_
49 _filename_---the file this func was run on
50 _msg_---a string containing the failure message
54 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
56 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)
58 ## Function **HAS-NO-EXAMPLES**
62 **has-no-examples** => _result_
64 ```result::= success-result | failure-result```
65 ```success-result::= (:success filename)```
66 ```failure-result::= (:failure filename msg)```
68 #### Arguments and Values:
70 _filename_---the file this func was run on
71 _msg_---a string containing the failure message
75 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
77 ## Function **HAS-OPTIONAL**
81 **has-optional** _path_ _&optional_ _x_ => _result_
83 ```result::= success-result | failure-result```
84 ```success-result::= (:success filename)```
85 ```failure-result::= (:failure filename msg)```
87 #### Arguments and Values:
90 _x_---a random value related to _path_
91 _filename_---the file this func was run on
92 _msg_---a string containing the failure message
96 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
98 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)
100 ## Function **HAS-REST**
104 **has-rest** _path_ _&rest_ _x_ => _result_
106 ```result::= success-result | failure-result```
107 ```success-result::= (:success filename)```
108 ```failure-result::= (:failure filename msg)```
110 #### Arguments and Values:
113 _x_---a random value related to _path_
114 _filename_---the file this func was run on
115 _msg_---a string containing the failure message
119 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
121 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)
123 ## Function **NOARGS**
127 **noargs** => _result_
129 ```result::= success-result | failure-result```
130 ```success-result::= (:success filename)```
131 ```failure-result::= (:failure filename msg)```
133 #### Arguments and Values:
135 _filename_---the file this func was run on
136 _msg_---a string containing the failure message
140 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
144 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
145 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
147 ## Function **RESULT-LIST**
151 **result-list** => _result_
153 ```result::= failure-result*```
154 ```failure-result::= (:failure filename msg)```
156 #### Arguments and Values:
158 _filename_---the file this func was run on
159 _msg_---a string containing the failure message
163 NOARGS runs all the things against a file and returns as soon as the first func error is found.
165 ## Condition TEST-CONDITION
167 Simple documentation.
169 For a simple condition.
171 ## Function **VALUES-RESULT**
175 **values-result** => _result1_, _result2_, _result3_
177 ```result1::= success-result | failure-result```
178 ```success-result::= (:success filename)```
179 ```failure-result::= (:failure filename msg)```
181 #### Arguments and Values:
183 _result2_---second result
184 _result3_---third result
185 _filename_---the file this func was run on
186 _msg_---a string containing the failure message
190 _values-result_ runs all the things against a file and returns as soon as the first func error is found.