Remove need for ARGUMENTS AND VALUES when there are none

[sheep] / resources / success1.lisp

diff --git a/resources/success1.lisp b/resources/success1.lisp
index 338b5b63afe3f13d72291159ef76b4a480749bcb..28d492df7cdae39169d04b6a1798e03400858495 100644 (file)
--- a/resources/success1.lisp
+++ b/resources/success1.lisp
@@ -5,12 +5,35 @@
 This is should all get pulled in and the markdown.md should be equal
 to success1.md.")
  (:export
+  #:*special-variable*
   #:test-condition
-  #:func-that-does-stuff #:noargs #:result-list #:has-no-examples
+  #: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.
@@ -58,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)
 
@@ -85,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