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 * **variable [\*special\-variable\-2\*](#variable-special-variable-2)** - It is special, and a boolean.
  11 * **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.
  12 * **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.
  13 * **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.
  14 * **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.
  15 * **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.
  16 * **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.
  17 * **function [noargs](#function-noargs)** - _noargs_ runs all the things against a file and returns as soon as the first func error is found.
  18 * **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.
  19 * **condition [test-condition](#condition-test-condition)** - Simple documentation.
  20 * **structure [test-struct](#struct-test-struct)** - Simple documentation.
  21 * **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.
  22
  23 ## Variable \*SPECIAL\-VARIABLE\*
  24
  25 #### Value Type:
  26
  27 a generalized boolean
  28
  29 #### Initial Value:
  30
  31 NIL
  32
  33 #### Description:
  34
  35 It is special, and a boolean.
  36
  37 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.
  38
  39 But sometimes it needs to reference itself: _*special-variable*_
  40
  41 #### Examples:
  42
  43 ```(let ((*special-variable* t)) (go))``` => ```'let-it-go```
  44
  45 ## Variable \*SPECIAL\-VARIABLE\-2\*
  46
  47 #### Value Type:
  48
  49 a generalized boolean
  50
  51 #### Initial Value:
  52
  53 NIL
  54
  55 #### Description:
  56
  57 It is special, and a boolean.
  58
  59 ## Function **FUNC-THAT-DOES-STUFF**
  60
  61 #### Syntax:
  62
  63 **func-that-does-stuff** _path_ _x_ => _result_
  64
  65 ```result::= success-result | failure-result```
  66 ```success-result::= (:success filename)```
  67 ```failure-result::= (:failure filename msg)```
  68
  69 #### Arguments and Values:
  70
  71 _path_---a pathname
  72 _x_---a random value related to _path_
  73 _filename_---the file this func was run on
  74 _msg_---a string containing the failure message
  75
  76 #### Description:
  77
  78 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
  79
  80 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)
  81
  82 #### Examples:
  83
  84 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
  85 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
  86
  87 ## Function **HAS-KEYWORDS**
  88
  89 #### Syntax:
  90
  91 **has-keywords** _path_ _&key_ _x_ => _result_
  92
  93 ```result::= success-result | failure-result```
  94 ```success-result::= (:success filename)```
  95 ```failure-result::= (:failure filename msg)```
  96
  97 #### Arguments and Values:
  98
  99 _path_---a pathname
 100 _x_---a random value related to _path_
 101 _filename_---the file this func was run on
 102 _msg_---a string containing the failure message
 103
 104 #### Description:
 105
 106 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
 107
 108 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)
 109
 110 ## Function **HAS-NO-EXAMPLES**
 111
 112 #### Syntax:
 113
 114 **has-no-examples** => _result_
 115
 116 ```result::= success-result | failure-result```
 117 ```success-result::= (:success filename)```
 118 ```failure-result::= (:failure filename msg)```
 119
 120 #### Arguments and Values:
 121
 122 _filename_---the file this func was run on
 123 _msg_---a string containing the failure message
 124
 125 #### Description:
 126
 127 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
 128
 129 ## Function **HAS-OPTIONAL**
 130
 131 #### Syntax:
 132
 133 **has-optional** _path_ _&optional_ _x_ => _result_
 134
 135 ```result::= success-result | failure-result```
 136 ```success-result::= (:success filename)```
 137 ```failure-result::= (:failure filename msg)```
 138
 139 #### Arguments and Values:
 140
 141 _path_---a pathname
 142 _x_---a random value related to _path_
 143 _filename_---the file this func was run on
 144 _msg_---a string containing the failure message
 145
 146 #### Description:
 147
 148 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
 149
 150 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)
 151
 152 ## Function **HAS-REST**
 153
 154 #### Syntax:
 155
 156 **has-rest** _path_ _&rest_ _x_ => _result_
 157
 158 ```result::= success-result | failure-result```
 159 ```success-result::= (:success filename)```
 160 ```failure-result::= (:failure filename msg)```
 161
 162 #### Arguments and Values:
 163
 164 _path_---a pathname
 165 _x_---a random value related to _path_
 166 _filename_---the file this func was run on
 167 _msg_---a string containing the failure message
 168
 169 #### Description:
 170
 171 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
 172
 173 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)
 174
 175 ## Function **NO-ARGS-AND-VALUES**
 176
 177 #### Syntax:
 178
 179 **no-args-and-values** => _result_
 180
 181 ```result::= :nothing```
 182
 183 #### Description:
 184
 185 _result_-LIST runs all the things against a file and returns as soon as the first func error is found.
 186
 187 ## Function **NOARGS**
 188
 189 #### Syntax:
 190
 191 **noargs** => _result_
 192
 193 ```result::= success-result | failure-result```
 194 ```success-result::= (:success filename)```
 195 ```failure-result::= (:failure filename msg)```
 196
 197 #### Arguments and Values:
 198
 199 _filename_---the file this func was run on
 200 _msg_---a string containing the failure message
 201
 202 #### Description:
 203
 204 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
 205
 206 #### Examples:
 207
 208 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
 209 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
 210
 211 ## Function **RESULT-LIST**
 212
 213 #### Syntax:
 214
 215 **result-list** => _result_
 216
 217 ```result::= failure-result*```
 218 ```failure-result::= (:failure filename msg)```
 219
 220 #### Arguments and Values:
 221
 222 _filename_---the file this func was run on
 223 _msg_---a string containing the failure message
 224
 225 #### Description:
 226
 227 _result-list_ runs all the things against a file and returns as soon as the first func error is found.
 228
 229 ## Condition TEST-CONDITION
 230
 231 Simple documentation.
 232
 233 For a simple condition.
 234
 235 ## Struct TEST-STRUCT
 236
 237 Simple documentation.
 238
 239 For a simple structure.  But this structure may go to two lines for this part of it.
 240
 241 ## Function **VALUES-RESULT**
 242
 243 #### Syntax:
 244
 245 **values-result** => _result1_, _result2_, _result3_
 246
 247 ```result1::= success-result | failure-result```
 248 ```success-result::= (:success filename)```
 249 ```failure-result::= (:failure filename msg)```
 250
 251 #### Arguments and Values:
 252
 253 _result2_---second result
 254 _result3_---third result
 255 _filename_---the file this func was run on
 256 _msg_---a string containing the failure message
 257
 258 #### Description:
 259
 260 _values-result_ runs all the things against a file and returns as soon as the first func error is found.