Add docstring to EXPLAIN
authorStelian Ionescu <sionescu@cddr.org>
Mon, 23 Apr 2012 10:53:11 +0000 (12:53 +0200)
committerStelian Ionescu <sionescu@cddr.org>
Mon, 23 Apr 2012 10:53:11 +0000 (12:53 +0200)
src/explain.lisp

index 12e5e1f..e29b676 100644 (file)
 ;;;; which prints a human readable summary (number passed, number
 ;;;; failed, what failed and why, etc.) of a list of test results.
 
-(defgeneric explain (explainer results &optional stream recursive-depth))
+(defgeneric explain (explainer results &optional stream recursive-depth)
+  (:documentation "Given a list of test results report write to stream detailed
+ human readable statistics regarding the results."))
 
 (defmethod explain ((exp detailed-text-explainer) results
                     &optional (stream *test-dribble*) (recursive-depth 0))
-  #| "Given a list of test results report write to stream detailed
-  human readable statistics regarding the results." |#
   (multiple-value-bind (num-checks passed num-passed passed%
                                    skipped num-skipped skipped%
                                    failed num-failed failed%