From: Lars Magne Ingebrigtsen <larsi@gnus.org>
Date: Sat, 2 Jul 2011 13:08:07 +0000 (+0200)
Subject: * streams.texi (Output Functions): Document `pp'.
X-Git-Tag: emacs-pretest-24.0.90~104^2~152^2~253
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=36cb87a1f49b96361c2b807253f5858c88aabead;p=emacs.git

* streams.texi (Output Functions): Document `pp'.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 7946e4b91ff..8cea06eb30a 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
+2011-07-02  Lars Magne Ingebrigtsen  <larsi@gnus.org>
+
+	* streams.texi (Output Functions): Document `pp'.
+
 2011-06-25  Chong Yidong  <cyd@stupidchicken.com>
 
 	* keymaps.texi (Searching Keymaps):
diff --git a/doc/lispref/streams.texi b/doc/lispref/streams.texi
index 9802c7485dd..4d3a66d8852 100644
--- a/doc/lispref/streams.texi
+++ b/doc/lispref/streams.texi
@@ -684,6 +684,12 @@ For example, if the current buffer name is @samp{foo},
 returns @code{"The buffer is foo"}.
 @end defmac
 
+@defun pp object &optional stream
+This function outputs @var{object} to @var{stream}, just like
+@code{prin1}, but does it in a more ``pretty'' way.  That is, it'll
+indent and fill the object to make it more readable for humans.
+@end defun
+
 @node Output Variables
 @section Variables Affecting Output
 @cindex output-controlling variables