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#12686: PATCH: ambiguous help doc strings Date: Thu, 25 Oct 2012 11:29:57 -0700 Message-ID: References: <87wqyh7i20.fsf@mail.jurta.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1351189877 13720 80.91.229.3 (25 Oct 2012 18:31:17 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 25 Oct 2012 18:31:17 +0000 (UTC) Cc: 12686@debbugs.gnu.org, "'Aaron S. Hawley'" To: "'Stefan Monnier'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Oct 25 20:31:24 2012 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1TRSDC-0000cV-TT for geb-bug-gnu-emacs@m.gmane.org; Thu, 25 Oct 2012 20:31:23 +0200 Original-Received: from localhost ([::1]:41695 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TRSD4-0007jE-T3 for geb-bug-gnu-emacs@m.gmane.org; Thu, 25 Oct 2012 14:31:14 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:49877) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TRSCt-0007ij-NJ for bug-gnu-emacs@gnu.org; Thu, 25 Oct 2012 14:31:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TRSCn-00080H-VM for bug-gnu-emacs@gnu.org; Thu, 25 Oct 2012 14:31:03 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:51614) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TRSCn-00080D-Rn for bug-gnu-emacs@gnu.org; Thu, 25 Oct 2012 14:30:57 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1TRSEo-0004lw-9a for bug-gnu-emacs@gnu.org; Thu, 25 Oct 2012 14:33:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 25 Oct 2012 18:33:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 12686 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 12686-submit@debbugs.gnu.org id=B12686.135118993918294 (code B ref 12686); Thu, 25 Oct 2012 18:33:02 +0000 Original-Received: (at 12686) by debbugs.gnu.org; 25 Oct 2012 18:32:19 +0000 Original-Received: from localhost ([127.0.0.1]:33632 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TRSE3-0004kx-LE for submit@debbugs.gnu.org; Thu, 25 Oct 2012 14:32:17 -0400 Original-Received: from rcsinet15.oracle.com ([148.87.113.117]:51060) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TRSE0-0004ko-At for 12686@debbugs.gnu.org; Thu, 25 Oct 2012 14:32:13 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by rcsinet15.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id q9PIU02g029206 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Thu, 25 Oct 2012 18:30:01 GMT Original-Received: from acsmt357.oracle.com (acsmt357.oracle.com [141.146.40.157]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id q9PITxxR000872 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Thu, 25 Oct 2012 18:29:59 GMT Original-Received: from abhmt111.oracle.com (abhmt111.oracle.com [141.146.116.63]) by acsmt357.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id q9PITwGA016984; Thu, 25 Oct 2012 13:29:59 -0500 Original-Received: from dradamslap1 (/130.35.178.248) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Thu, 25 Oct 2012 11:29:58 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: Thread-Index: Ac2xQDF+aN9tF0wNTC6XDhE0IMzhqgBnZpgw X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) 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:66047 Archived-At: > What I meant is that for minor-modes we shouldn't show the > help for the function plus the help for the variable but a > single help for the minor-mode which describes both as a > single entity. Why? What's the difference? IOW, just what do you mean by "as a single entity"? Anyway, sounds OK to me. But if this is not done right away, why not at least do as I suggested in the meantime: move the var-or-fn clause first, so that if a symbol is both it gets treated as both. And that would seem to be appropriate anyway, even if you also do as you suggest, to accommodate other symbols that do not correspond to a minor-mode but which have both var and fun definitions. IOW, minor modes are not the only case to consider, even if they are an important case. I would like to see all doc for a symbol, which could have definitions as a face, a var, a function, and perhaps even a group (anything else?). The cond clauses should be ordered accordingly, rather than favoring some kinds of thingy to the exclusion of others.