X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=sheep;a=blobdiff_plain;f=resources%2Fsuccess1.lisp;h=28d492df7cdae39169d04b6a1798e03400858495;hp=57df504e22dfeaffdbaf8193e751c3b679db0303;hb=d898031;hpb=4c8ef06ce7bff14e78e79051870291d5075c42ea diff --git a/resources/success1.lisp b/resources/success1.lisp index 57df504..28d492d 100644 --- a/resources/success1.lisp +++ b/resources/success1.lisp @@ -5,12 +5,41 @@ This is should all get pulled in and the markdown.md should be equal to success1.md.") (:export - #:func-that-does-stuff #:noargs #:result-list #:has-no-examples - #:values-result #:has-optional #:has-keywords #:has-rest - )) + #:*special-variable* + #:test-condition + #:func-that-does-stuff #:noargs #:no-args-and-values #:result-list #:has-no-examples + #:values-result #:has-optional #:has-keywords #:has-rest)) (in-package #:success1) +(defvar *special-variable* nil + "*SPECIAL-VARIABLE* + +VALUE TYPE: + + a generalized boolean + +INITIAL VALUE: + + NIL + +DESCRIPTION: + + It is special, and a boolean. + + 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. + +EXAMPLES: + + (let ((*special-variable* t)) (go)) => 'let-it-go") + +(define-condition test-condition nil nil + (:documentation + "Simple documentation. + +For a simple condition.")) + (defun func-that-does-stuff (path x) "FUNC-THAT-DOES-STUFF PATH X => RESULT @@ -52,7 +81,7 @@ ARGUMENTS AND VALUES: DESCRIPTION: - NOARGS runs all the things against a file and returns + RESULT-LIST runs all the things against a file and returns as soon as the first func error is found." nil) @@ -79,6 +108,17 @@ EXAMPLES: (func-that-does-stuff) => (:failure \"path/to/error.lisp\" \"Error msg\" 20 0)" nil) +(defun no-args-and-values () + "NO-ARGS-AND-VALUES => RESULT + + RESULT: :nothing + +DESCRIPTION: + + RESULT-LIST runs all the things against a file and returns + as soon as the first func error is found." + nil) + (defun has-no-examples () "HAS-NO-EXAMPLES => RESULT