From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#8452: 24.0.50; doc of `pp' and related functions Date: Sat, 2 Jul 2011 08:09:44 -0700 Message-ID: References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1309619486 25765 80.91.229.12 (2 Jul 2011 15:11:26 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sat, 2 Jul 2011 15:11:26 +0000 (UTC) Cc: 8452@debbugs.gnu.org To: "'Lars Magne Ingebrigtsen'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Jul 02 17:11:22 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qd1qp-0007xG-Ad for geb-bug-gnu-emacs@m.gmane.org; Sat, 02 Jul 2011 17:11:19 +0200 Original-Received: from localhost ([::1]:40884 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qd1qo-0007lg-5k for geb-bug-gnu-emacs@m.gmane.org; Sat, 02 Jul 2011 11:11:18 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:60493) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qd1qa-0007lb-29 for bug-gnu-emacs@gnu.org; Sat, 02 Jul 2011 11:11:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qd1qY-0005gd-U5 for bug-gnu-emacs@gnu.org; Sat, 02 Jul 2011 11:11:03 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:37572) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qd1qY-0005gZ-RH for bug-gnu-emacs@gnu.org; Sat, 02 Jul 2011 11:11:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1Qd1qY-0004UD-AW; Sat, 02 Jul 2011 11:11:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 02 Jul 2011 15:11:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 8452 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed Original-Received: via spool by 8452-submit@debbugs.gnu.org id=B8452.130961941117181 (code B ref 8452); Sat, 02 Jul 2011 15:11:02 +0000 Original-Received: (at 8452) by debbugs.gnu.org; 2 Jul 2011 15:10:11 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qd1pi-0004T4-I8 for submit@debbugs.gnu.org; Sat, 02 Jul 2011 11:10:10 -0400 Original-Received: from rcsinet15.oracle.com ([148.87.113.117]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qd1pg-0004Sl-NB for 8452@debbugs.gnu.org; Sat, 02 Jul 2011 11:10:09 -0400 Original-Received: from rtcsinet21.oracle.com (rtcsinet21.oracle.com [66.248.204.29]) by rcsinet15.oracle.com (Switch-3.4.4/Switch-3.4.4) with ESMTP id p62FA0JB004761 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sat, 2 Jul 2011 15:10:02 GMT Original-Received: from acsmt357.oracle.com (acsmt357.oracle.com [141.146.40.157]) by rtcsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id p62F9xtC023669 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Sat, 2 Jul 2011 15:09:59 GMT Original-Received: from abhmt107.oracle.com (abhmt107.oracle.com [141.146.116.59]) by acsmt357.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id p62F9rrV007789; Sat, 2 Jul 2011 10:09:53 -0500 Original-Received: from dradamslap1 (/10.159.63.244) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 02 Jul 2011 08:09:53 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: Thread-Index: Acw4unZ+xHrOa5E2RkKEiVaZK9V8FgAC3K/g X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6109 X-Source-IP: rtcsinet21.oracle.com [66.248.204.29] X-CT-RefId: str=0001.0A090204.4E0F34CA.005B:SCFSTAT5015188, ss=1, re=-4.000, fgs=0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Sat, 02 Jul 2011 11:11:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:47757 Archived-At: > > 1. Please add to the doc (e.g. doc strings) for `pp' and similar > > functions a mention of the various `print-*' variables that are > > respected and (if any) not respected. In particular, > > `print-circle'. > > I've had a look at the source code, and as far as I can see, > it doesn't handle any of the `print-*' variables explicitly, > but leaves that to princ and friends. > > So I don't think there's anything there much to add to the > doc strings. 1. Users should not need to dive into the `pp' source code to discover its behavior. The doc string should describe that. And its behavior is designed to change with these vars. Those behavior differences need to be pointed out. Those print-* vars are specifically designed to influence the behavior of the print functions, and the doc for the print functions should call that out. It's about the behavior ("interface") of the function, not its implementation. 2. That `pp' does its work using `princ' etc. is irrelevant to describing its behavior. Unless, that is, we must punt for some reason and explicitly say "see XYZ for how `pp' behaves with respect to variables A, B, C". If you do that, OK. But that would likely be more long-winded than to just say directly that the behavior of `pp' depends on those vars. In general, it is better for the behavior of `pp' to be called out in its own doc, rather than to refer to the behavior of other functions. It's about user convenience - why add indirection? 3. This bug is not just about `pp'. It is about (the doc of) "`pp' and similar functions": pp pp-buffer pp-display-expression pp-eval-expression pp-eval-last-sexp pp-last-sexp pp-macroexpand-expression pp-macroexpand-last-sexp pp-to-string Some of these are even commands. Users should especially know about the command behaviors wrt the print-* vars. Variable `print-circle' is even `user-variable-p': a variable intended to be modified by users. > > 2. Please document `pp' and its relatives in the Elisp > > manual, and index them. > > Ok; done. Thanks.