From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Bill Wohler Newsgroups: gmane.emacs.devel Subject: Re: checkdoc: URLs in docstrings with lisp symbols Date: Fri, 28 Oct 2005 15:01:16 -0700 Organization: Newt Software Message-ID: <8764rhcndf.fsf@olgas.newt.com> References: <31877.1130453516@olgas.newt.com> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1130537451 13550 80.91.229.2 (28 Oct 2005 22:10:51 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 28 Oct 2005 22:10:51 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Oct 29 00:10:49 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1EVcON-00078L-Oa for ged-emacs-devel@m.gmane.org; Sat, 29 Oct 2005 00:08:08 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1EVcON-0005EM-GJ for ged-emacs-devel@m.gmane.org; Fri, 28 Oct 2005 18:08:07 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1EVcMQ-0004Un-P8 for emacs-devel@gnu.org; Fri, 28 Oct 2005 18:06:07 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1EVcMN-0004T0-Kd for emacs-devel@gnu.org; Fri, 28 Oct 2005 18:06:04 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1EVcMN-0004Sl-2v for emacs-devel@gnu.org; Fri, 28 Oct 2005 18:06:03 -0400 Original-Received: from [80.91.229.2] (helo=ciao.gmane.org) by monty-python.gnu.org with esmtp (TLS-1.0:RSA_AES_128_CBC_SHA:16) (Exim 4.34) id 1EVcML-0005gQ-LI for emacs-devel@gnu.org; Fri, 28 Oct 2005 18:06:02 -0400 Original-Received: from list by ciao.gmane.org with local (Exim 4.43) id 1EVcKU-00061Y-Dr for emacs-devel@gnu.org; Sat, 29 Oct 2005 00:04:06 +0200 Original-Received: from h-68-165-5-222.snvacaid.dynamic.covad.net ([68.165.5.222]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sat, 29 Oct 2005 00:04:06 +0200 Original-Received: from wohler by h-68-165-5-222.snvacaid.dynamic.covad.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sat, 29 Oct 2005 00:04:06 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-To: emacs-devel@gnu.org Original-Lines: 33 Original-X-Complaints-To: usenet@sea.gmane.org X-Gmane-NNTP-Posting-Host: h-68-165-5-222.snvacaid.dynamic.covad.net User-Agent: Gnus/5.110004 (No Gnus v0.4) Emacs/21.4 (gnu/linux) Cancel-Lock: sha1:S48+KSHy57AOPbwS69+mKyjD1LE= 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:45053 Archived-At: "Richard M. Stallman" writes: > checkdoc ignores the make-face string but complains that the make-face > bit in the URL should be quoted `'. The Info node (elisp)Documentation > Tips doesn't say how URLs should be treated. > > The right way to treat them would be in a way that enables > the help facility to follow the link and display the URL. > I tend to think that `' quoting is the natural way to implement that. > Would you like to implement that? That sounds like a good idea. Done. I've updated help-mode.el based upon the code to follow Info references. The code now recognizes strings like "URL `http://www.gnu.org/'" and uses browse-url to view them. I've updated etc/NEWS, man/help.texi, and lispref/tips.texi with this new feature. However, I haven't yet documented that this feature uses browse-url. It seems that the user should know where to go to customize his browsing experience. Should I mention this in (emacs)Help Mode. If not, where? p.s. Eli will notice that I documented the use of "URL" but the code accepts "url" as well ;-). This is intentional. I'd prefer folks use uppercase for acronyms, but I wanted the code to be liberal. -- Bill Wohler http://www.newt.com/wohler/ GnuPG ID:610BD9AD Maintainer of comp.mail.mh FAQ and MH-E. Vote Libertarian! If you're passed on the right, you're in the wrong lane.