chiark / gitweb /
Don't write Lisp symbol names in uppercase: use `...' instead.
[sod] / src / parser / streams-impl.lisp
index 6094b569a2a1d7cce3c835ed8f7284074eba0257..d62429a9927caf687df4aaa38a6b0e56bb81b88c 100644 (file)
@@ -225,10 +225,10 @@ (defclass position-aware-stream (proxy-stream)
    character increases the line number by one and resets the column number to
    zero; most characters advance the column number by one, but tab advances
    to the next multiple of eight.  (This is consistent with Emacs, at least.)
-   The position can be read using STREAM-LINE-AND-COLUMN.
+   The position can be read using `stream-line-and-column'.
 
-   This is a base class; you probably want POSITION-AWARE-INPUT-STREAM or
-   POSITION-AWARE-OUTPUT-STREAM."))
+   This is a base class; you probably want `position-aware-input-stream' or
+   `position-aware-output-stream'."))
 
 (defgeneric stream-line-and-column (stream)
   (:documentation
@@ -243,12 +243,12 @@ (defgeneric stream-line-and-column (stream)
       (values line column))))
 
 (defmethod stream-pathname ((stream position-aware-stream))
-  "Return the pathname corresponding to a POSITION-AWARE-STREAM.
+  "Return the pathname corresponding to a `position-aware-stream'.
 
-   A POSITION-AWARE-STREAM can be given an explicit pathname, which is
+   A `position-aware-stream' can be given an explicit pathname, which is
    returned in preference to the pathname of the underlying stream.  This is
    useful in two circumstances.  Firstly, the pathname associated with a file
-   stream will have been subjected to TRUENAME, and may be less pleasant to
+   stream will have been subjected to `truename', and may be less pleasant to
    present back to a user.  Secondly, a name can be attached to a stream
    which doesn't actually have a file backing it."
 
@@ -269,7 +269,7 @@ (defmacro with-position ((stream) &body body)
 
    The position is actually cached in local variables, but will be written
    back to the stream even in the case of non-local control transfer from the
-   BODY.  What won't work well is dynamically nesting WITH-POSITION forms."
+   BODY.  What won't work well is dynamically nesting `with-position' forms."
 
   (with-gensyms (line column char)
     (once-only (stream)