Add docstring to EXPLAIN

[fiveam.git] / src / explain.lisp

diff --git a/src/explain.lisp b/src/explain.lisp
index 42c6225..e29b676 100644 (file)
--- a/src/explain.lisp
+++ b/src/explain.lisp
@@ -1,4 +1,4 @@
-;; -*- lisp -*-
+;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
 
 (in-package :it.bese.fiveam)
 
@@ -12,10 +12,12 @@
 ;;;; 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)
+  (: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%