From: Mark Wooding <mdw@distorted.org.uk>
Date: Sun, 30 Aug 2015 09:58:38 +0000 (+0100)
Subject: src/classes.lisp, src/class-layout-proto.lisp: Docstring fixes.
X-Git-Tag: 0.2.0~36
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/sod/commitdiff_plain/2aa518549b302b3556dbaa42585e6fc16a63ae7c

src/classes.lisp, src/class-layout-proto.lisp: Docstring fixes.

Specifically, name literal symbols in lowercase, with quotes, to
distinguish from metasyntactic variables.
---

diff --git a/src/class-layout-proto.lisp b/src/class-layout-proto.lisp
index ef75710..19bb897 100644
--- a/src/class-layout-proto.lisp
+++ b/src/class-layout-proto.lisp
@@ -172,14 +172,14 @@ (defclass vtmsgs ()
 (export 'compte-vtmsgs)
 (defgeneric compute-vtmsgs (class subclass chain-head chain-tail)
   (:documentation
-   "Return a VTMSGS object containing method entries for CLASS.
+   "Return a `vtmsgs' object containing method entries for CLASS.
 
    The CHAIN-HEAD describes which chain the method entries should be
    constructed for.
 
-   The default method simply calls MAKE-METHOD-ENTRY for each of the methods
-   and wraps a VTMSGS object around them.  This ought to be enough for almost
-   all purposes."))
+   The default method simply calls `make-method-entry' for each of the
+   methods and wraps a `vtmsgs' object around them.  This ought to be enough
+   for almost all purposes."))
 
 ;;; class-pointer
 
diff --git a/src/classes.lisp b/src/classes.lisp
index 603ea98..a670b8e 100644
--- a/src/classes.lisp
+++ b/src/classes.lisp
@@ -197,16 +197,16 @@ (defclass sod-class ()
    computed on demand via methods on `slot-unbound'.
 
      * The ILAYOUT describes the layout for an instance of the class.  It's
-       quite complicated; see the documentation of the ILAYOUT class for
+       quite complicated; see the documentation of the `ilayout' class for
        detais.
 
      * The EFFECTIVE-METHODS are a list of effective methods, specialized for
        the class.
 
      * The VTABLES are a list of descriptions of vtables for the class.  The
-       individual elements are VTABLE objects, which are even more
-       complicated than ILAYOUT structures.  See the class documentation for
-       details."))
+       individual elements are `vtable' objects, which are even more
+       complicated than `ilayout' structures.  See the class documentation
+       for details."))
 
 (defmethod print-object ((class sod-class) stream)
   (maybe-print-unreadable-object (class stream :type t)