src/class-finalize-proto.lisp (check-sod-class): Fix docstring.

Describe the actual, rather unsatisfactory, state of the world.
Fortunately, this will be fixed soon.

diff --git a/src/class-finalize-proto.lisp b/src/class-finalize-proto.lisp
index fcb8686cda97030932b6c9a97bc89f375ee581aa..7d7a992db4fb50582ebc1d48bcb2d79780d61171 100644 (file)
--- a/src/class-finalize-proto.lisp
+++ b/src/class-finalize-proto.lisp
@@ -81,8 +81,11 @@ (defgeneric check-sod-class (class)
      * The chosen metaclass is actually a subclass of all of the
        superclasses' metaclasses.
 
-   Returns true if all is well; false (and signals errors) if anything was
-   wrong."))
+   If no attempt has previously been made to finalize the class, then errors
+   are signalled for the problems found.  If finalizing it has been tried
+   before and failed (or this is a recursive attempt to finalize the class)
+   then nil is returned immediately.  Otherwise a non-nil value is
+   returned."))
 
 (export 'finalize-sod-class)
 (defgeneric finalize-sod-class (class)