1 ## Function **FUNC-THAT-DOES-STUFF**
5 **func-that-does-stuff** _path_ _x_ => _result_
7 ```result::= success-result | failure-result```
8 ```success-result::= (:success filename)```
9 ```failure-result::= (:failure filename msg)```
11 #### Arguments and Values:
14 _x_---a random value related to _path_
15 _filename_---the file this func was run on
16 _msg_---a string containing the failure message
20 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
22 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)
26 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
27 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
29 ## Function **HAS-KEYWORDS**
33 **has-keywords** _path_ _&key_ _x_ => _result_
35 ```result::= success-result | failure-result```
36 ```success-result::= (:success filename)```
37 ```failure-result::= (:failure filename msg)```
39 #### Arguments and Values:
42 _x_---a random value related to _path_
43 _filename_---the file this func was run on
44 _msg_---a string containing the failure message
48 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
50 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)
52 ## Function **HAS-NO-EXAMPLES**
56 **has-no-examples** => _result_
58 ```result::= success-result | failure-result```
59 ```success-result::= (:success filename)```
60 ```failure-result::= (:failure filename msg)```
62 #### Arguments and Values:
64 _filename_---the file this func was run on
65 _msg_---a string containing the failure message
69 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
71 ## Function **HAS-OPTIONAL**
75 **has-optional** _path_ _&optional_ _x_ => _result_
77 ```result::= success-result | failure-result```
78 ```success-result::= (:success filename)```
79 ```failure-result::= (:failure filename msg)```
81 #### Arguments and Values:
84 _x_---a random value related to _path_
85 _filename_---the file this func was run on
86 _msg_---a string containing the failure message
90 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
92 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)
94 ## Function **HAS-REST**
98 **has-rest** _path_ _&rest_ _x_ => _result_
100 ```result::= success-result | failure-result```
101 ```success-result::= (:success filename)```
102 ```failure-result::= (:failure filename msg)```
104 #### Arguments and Values:
107 _x_---a random value related to _path_
108 _filename_---the file this func was run on
109 _msg_---a string containing the failure message
113 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
115 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)
117 ## Function **NOARGS**
121 **noargs** => _result_
123 ```result::= success-result | failure-result```
124 ```success-result::= (:success filename)```
125 ```failure-result::= (:failure filename msg)```
127 #### Arguments and Values:
129 _filename_---the file this func was run on
130 _msg_---a string containing the failure message
134 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
138 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
139 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
141 ## Function **RESULT-LIST**
145 **result-list** => _result_
147 ```result::= failure-result*```
148 ```failure-result::= (:failure filename msg)```
150 #### Arguments and Values:
152 _filename_---the file this func was run on
153 _msg_---a string containing the failure message
157 NOARGS runs all the things against a file and returns as soon as the first func error is found.
159 ## Function **VALUES-RESULT**
163 **values-result** => _result1_, _result2_, _result3_
165 ```result1::= success-result | failure-result```
166 ```success-result::= (:success filename)```
167 ```failure-result::= (:failure filename msg)```
169 #### Arguments and Values:
171 _result2_---second result
172 _result3_---third result
173 _filename_---the file this func was run on
174 _msg_---a string containing the failure message
178 _values-result_ runs all the things against a file and returns as soon as the first func error is found.