From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Miles Bader Newsgroups: gmane.emacs.devel Subject: Re: doc string for face-attribute-relative-p doesn't help Date: Tue, 27 Jun 2006 12:52:37 +0900 Message-ID: References: Reply-To: Miles Bader NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1151380385 1599 80.91.229.2 (27 Jun 2006 03:53:05 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 27 Jun 2006 03:53:05 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Jun 27 05:53:02 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1Fv4dG-0004Yw-1v for ged-emacs-devel@m.gmane.org; Tue, 27 Jun 2006 05:52:58 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Fv4dF-0000or-ID for ged-emacs-devel@m.gmane.org; Mon, 26 Jun 2006 23:52:57 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Fv4d6-0000om-CK for emacs-devel@gnu.org; Mon, 26 Jun 2006 23:52:48 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Fv4d4-0000oZ-NQ for emacs-devel@gnu.org; Mon, 26 Jun 2006 23:52:48 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Fv4d4-0000oW-KH for emacs-devel@gnu.org; Mon, 26 Jun 2006 23:52:46 -0400 Original-Received: from [203.180.232.83] (helo=mgate03.necel.com) by monty-python.gnu.org with esmtp (Exim 4.52) id 1Fv4p4-00065G-CQ; Tue, 27 Jun 2006 00:05:10 -0400 Original-Received: from relay31.aps.necel.com (relay31 [10.29.19.54]) by mgate03.necel.com (8.13.6/8.13.1) with ESMTP id k5R3Zd7G015827; Tue, 27 Jun 2006 12:52:40 +0900 (JST) Original-Received: from relay31.aps.necel.com ([10.29.19.16] [10.29.19.16]) by relay31.aps.necel.com with ESMTP; Tue, 27 Jun 2006 12:52:40 +0900 Original-Received: from dhapc248.dev.necel.com ([10.114.97.235] [10.114.97.235]) by relay31.aps.necel.com with ESMTP; Tue, 27 Jun 2006 12:52:40 +0900 Original-Received: by dhapc248.dev.necel.com (Postfix, from userid 31295) id 95C2E440; Tue, 27 Jun 2006 12:52:39 +0900 (JST) Original-To: "Drew Adams" System-Type: i686-pc-linux-gnu Blat: Foop In-Reply-To: (Drew Adams's message of "Mon, 26 Jun 2006 20:33:03 -0700") Original-Lines: 22 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:56213 Archived-At: "Drew Adams" writes: > I agree, too, that each function's doc string need not try to explain > everything. If the doc defines the terms it uses (e.g. "underlying", > "relative") and explains them clearly, then that lessens the burden of > explanation for doc strings. I've always wondered if there should be more attempts to link from docstrings into the elisp manual. It would reduce the burden of trying to make docstrings too all-encompassing. Consider, for instance, if there were automatically added "See (elisp)FUNCTION-NAME" and/or "See (elisp)faces" links at the bottom of _every_ face function's docstring. [I seem to recall that this was discussed in some manner before?? Anybody remember?] -miles -- o The existentialist, not having a pillow, goes everywhere with the book by Sullivan, _I am going to spit on your graves_.