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