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
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)
(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