code.consxy.com Git - sheep/blob - resources/success1.md

   1 # Package SUCCESS1
   2
   3 This defines a simple successful package.
   4
   5 This is should all get pulled in and the markdown.md should be equal to success1.md.
   6
   7 ## Contents
   8
   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.
  20
  21 ## Variable \*SPECIAL\-VARIABLE\*
  22
  23 #### Value Type:
  24
  25 a generalized boolean
  26
  27 #### Initial Value:
  28
  29 NIL
  30
  31 #### Description:
  32
  33 It is special, and a boolean.
  34
  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.
  36
  37 #### Examples:
  38
  39 ```(let ((*special-variable* t)) (go))``` => ```'let-it-go```
  40
  41 ## Function **FUNC-THAT-DOES-STUFF**
  42
  43 #### Syntax:
  44
  45 **func-that-does-stuff** _path_ _x_ => _result_
  46
  47 ```result::= success-result | failure-result```
  48 ```success-result::= (:success filename)```
  49 ```failure-result::= (:failure filename msg)```
  50
  51 #### Arguments and Values:
  52
  53 _path_---a pathname
  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
  57
  58 #### Description:
  59
  60 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
  61
  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)
  63
  64 #### Examples:
  65
  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)```
  68
  69 ## Function **HAS-KEYWORDS**
  70
  71 #### Syntax:
  72
  73 **has-keywords** _path_ _&key_ _x_ => _result_
  74
  75 ```result::= success-result | failure-result```
  76 ```success-result::= (:success filename)```
  77 ```failure-result::= (:failure filename msg)```
  78
  79 #### Arguments and Values:
  80
  81 _path_---a pathname
  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
  85
  86 #### Description:
  87
  88 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
  89
  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)
  91
  92 ## Function **HAS-NO-EXAMPLES**
  93
  94 #### Syntax:
  95
  96 **has-no-examples** => _result_
  97
  98 ```result::= success-result | failure-result```
  99 ```success-result::= (:success filename)```
 100 ```failure-result::= (:failure filename msg)```
 101
 102 #### Arguments and Values:
 103
 104 _filename_---the file this func was run on
 105 _msg_---a string containing the failure message
 106
 107 #### Description:
 108
 109 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
 110
 111 ## Function **HAS-OPTIONAL**
 112
 113 #### Syntax:
 114
 115 **has-optional** _path_ _&optional_ _x_ => _result_
 116
 117 ```result::= success-result | failure-result```
 118 ```success-result::= (:success filename)```
 119 ```failure-result::= (:failure filename msg)```
 120
 121 #### Arguments and Values:
 122
 123 _path_---a pathname
 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
 127
 128 #### Description:
 129
 130 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
 131
 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)
 133
 134 ## Function **HAS-REST**
 135
 136 #### Syntax:
 137
 138 **has-rest** _path_ _&rest_ _x_ => _result_
 139
 140 ```result::= success-result | failure-result```
 141 ```success-result::= (:success filename)```
 142 ```failure-result::= (:failure filename msg)```
 143
 144 #### Arguments and Values:
 145
 146 _path_---a pathname
 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
 150
 151 #### Description:
 152
 153 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
 154
 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)
 156
 157 ## Function **NO-ARGS-AND-VALUES**
 158
 159 #### Syntax:
 160
 161 **no-args-and-values** => _result_
 162
 163 ```result::= :nothing```
 164
 165 #### Description:
 166
 167 _result_-LIST runs all the things against a file and returns as soon as the first func error is found.
 168
 169 ## Function **NOARGS**
 170
 171 #### Syntax:
 172
 173 **noargs** => _result_
 174
 175 ```result::= success-result | failure-result```
 176 ```success-result::= (:success filename)```
 177 ```failure-result::= (:failure filename msg)```
 178
 179 #### Arguments and Values:
 180
 181 _filename_---the file this func was run on
 182 _msg_---a string containing the failure message
 183
 184 #### Description:
 185
 186 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
 187
 188 #### Examples:
 189
 190 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
 191 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
 192
 193 ## Function **RESULT-LIST**
 194
 195 #### Syntax:
 196
 197 **result-list** => _result_
 198
 199 ```result::= failure-result*```
 200 ```failure-result::= (:failure filename msg)```
 201
 202 #### Arguments and Values:
 203
 204 _filename_---the file this func was run on
 205 _msg_---a string containing the failure message
 206
 207 #### Description:
 208
 209 _result-list_ runs all the things against a file and returns as soon as the first func error is found.
 210
 211 ## Condition TEST-CONDITION
 212
 213 Simple documentation.
 214
 215 For a simple condition.
 216
 217 ## Function **VALUES-RESULT**
 218
 219 #### Syntax:
 220
 221 **values-result** => _result1_, _result2_, _result3_
 222
 223 ```result1::= success-result | failure-result```
 224 ```success-result::= (:success filename)```
 225 ```failure-result::= (:failure filename msg)```
 226
 227 #### Arguments and Values:
 228
 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
 233
 234 #### Description:
 235
 236 _values-result_ runs all the things against a file and returns as soon as the first func error is found.