From fd4b6e02bed59e2ae61823c2772460cc4ca2064f Mon Sep 17 00:00:00 2001 From: Stelian Ionescu Date: Mon, 23 Apr 2012 12:53:11 +0200 Subject: [PATCH] Add docstring to EXPLAIN --- src/explain.lisp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/explain.lisp b/src/explain.lisp index 12e5e1f..e29b676 100644 --- a/src/explain.lisp +++ b/src/explain.lisp @@ -12,12 +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)) +(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% -- 1.7.10.4