From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Juanma Barranquero" Newsgroups: gmane.emacs.devel Subject: Re: [drew.adams@oracle.com: RE: Customize doc strings and tagstrings do not respect \\<...> and \\[...]] Date: Fri, 16 Feb 2007 10:49:25 +0100 Message-ID: References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1171619705 30860 80.91.229.12 (16 Feb 2007 09:55:05 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 16 Feb 2007 09:55:05 +0000 (UTC) Cc: drew.adams@oracle.com, emacs-devel@gnu.org To: rms@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Feb 16 10:54:59 2007 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1HHznt-0002XE-AC for ged-emacs-devel@m.gmane.org; Fri, 16 Feb 2007 10:54:57 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1HHzns-0007la-B4 for ged-emacs-devel@m.gmane.org; Fri, 16 Feb 2007 04:54:56 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1HHzic-0005mY-Cu for emacs-devel@gnu.org; Fri, 16 Feb 2007 04:49:30 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1HHzia-0005kL-Ac for emacs-devel@gnu.org; Fri, 16 Feb 2007 04:49:29 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1HHziZ-0005jz-BE for emacs-devel@gnu.org; Fri, 16 Feb 2007 04:49:28 -0500 Original-Received: from wr-out-0506.google.com ([64.233.184.239]) by monty-python.gnu.org with esmtp (Exim 4.52) id 1HHziY-0005KU-VQ for emacs-devel@gnu.org; Fri, 16 Feb 2007 04:49:27 -0500 Original-Received: by wr-out-0506.google.com with SMTP id 69so1132225wri for ; Fri, 16 Feb 2007 01:49:26 -0800 (PST) DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=beta; h=received:message-id:date:from:to:subject:cc:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references; b=TcxNNgSc3hH7ADUg8CUVmXiNj1Q7+M42j9TNoPmiI7jgGqG+uT0K/x3BB+OrScLjq3v68e5TK3MIGx79oOKw87+SbRQ29eoJIOMXmpZEQ6n2Nej3fvKMVllx6St6DaJxMn9U+W472J/Eho9Pv4I6wfn18e2uAM1ZKVnd9bJYsZA= Original-Received: by 10.114.170.1 with SMTP id s1mr1612785wae.1171619365631; Fri, 16 Feb 2007 01:49:25 -0800 (PST) Original-Received: by 10.114.234.16 with HTTP; Fri, 16 Feb 2007 01:49:25 -0800 (PST) In-Reply-To: Content-Disposition: inline X-detected-kernel: Linux 2.4-2.6 (Google crawlbot) 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:66456 Archived-At: On 2/16/07, Richard Stallman wrote: > What did I say that about? The case where "Blah blah \\\\[some-command] more blah blah" turns into Blah blah Uses keymap "some-map", which is not currently defined. more blah blah > Do you consider using \\ in the docstring of an > autoloaded function a bug in the mode? > > Not particularly, but how does that relate? Because I agree with you that if you load a package, and a docstring from that package contains the above problem, it is a bug in the package; but this problem often happens for autoloaded functions, where not having the relevant mode-map at hand while consulting a docstring is quite normal. If you think that's an error in the package (as opposed to an error in `describe-function', `describe-variable', etc.), that would mean making sure that no autoloaded function ever references a mode-map with \\ > Is this the sort of output about which I said, "Any clueful user will > realize it means the mode has a bug and will report it, and then > things will be fixed so they really work."? Yes. > If so, I think that is true. If the mode produces this output, > it's a bug, and because it is visible it will get fixed. `checkdoc-minor-mode' is autoloaded, so it's a case like the ones I talk above. Either we make it not reference the mode-map, or we implement something like the "prominent notice" scheme I'm suggesting. > That seems like a good solution too, since it will also make the bug > visible. Great. Juanma