New directory

[bpt/emacs.git] / lisp / emacs-lisp / pp.el

diff --git a/lisp/emacs-lisp/pp.el b/lisp/emacs-lisp/pp.el
index beb79c7..2e54f22 100644 (file)
--- a/lisp/emacs-lisp/pp.el
+++ b/lisp/emacs-lisp/pp.el
@@ -1,8 +1,9 @@
 ;;; pp.el --- pretty printer for Emacs Lisp
 
-;; Copyright (C) 1989, 1993 Free Software Foundation, Inc.
+;; Copyright (C) 1989, 1993, 2001 Free Software Foundation, Inc.
 
 ;; Author: Randal Schwartz <merlyn@stonehenge.com>
+;; Keywords: lisp
 
 ;; This file is part of GNU Emacs.
 
@@ -21,21 +22,25 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
 ;;; Code:
+
 (defgroup pp nil
   "Pretty printer for Emacs Lisp."
   :prefix "pp-"
   :group 'lisp)
 
-(defcustom pp-escape-newlines t 
+(defcustom pp-escape-newlines t
   "*Value of `print-escape-newlines' used by pp-* functions."
   :type 'boolean
   :group 'pp)
 
+;;;###autoload
 (defun pp-to-string (object)
-  "Return a string containing the pretty-printed representation of OBJECT,
-any Lisp object.  Quoting characters are used when needed to make output
-that `read' can handle, whenever this is possible."
+  "Return a string containing the pretty-printed representation of OBJECT.
+OBJECT can be any Lisp object.  Quoting characters are used as needed
+to make output that `read' can handle, whenever this is possible."
   (save-excursion
     (set-buffer (generate-new-buffer " pp-to-string"))
     (unwind-protect
@@ -76,7 +81,7 @@ that `read' can handle, whenever this is possible."
 ;;;###autoload
 (defun pp (object &optional stream)
   "Output the pretty-printed representation of OBJECT, any Lisp object.
-Quoting characters are printed when needed to make output that `read'
+Quoting characters are printed as needed to make output that `read'
 can handle, whenever this is possible.
 Output stream is STREAM, or value of `standard-output' (which see)."
   (princ (pp-to-string object) (or stream standard-output)))
@@ -85,8 +90,8 @@ Output stream is STREAM, or value of `standard-output' (which see)."
 (defun pp-eval-expression (expression)
   "Evaluate EXPRESSION and pretty-print value into a new display buffer.
 If the pretty-printed value fits on one line, the message line is used
-instead.  Value is also consed on to front of variable  values 's
-value."
+instead.  The value is also consed onto the front of the list
+in the variable `values'."
   (interactive "xPp-eval: ")
   (setq values (cons (eval expression) values))
   (let* ((old-show-function temp-buffer-show-function)
@@ -162,4 +167,4 @@ Ignores leading comment characters."
 
 (provide 'pp)                          ; so (require 'pp) works
 
-;;; pp.el ends here.
+;;; pp.el ends here