unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Bill Wohler <wohler@newt.com>
Subject: checkdoc: URLs in docstrings with lisp symbols
Date: Thu, 27 Oct 2005 15:51:56 -0700	[thread overview]
Message-ID: <31877.1130453516@olgas.newt.com> (raw)

I have the following in a docstring:

  Use the \"make-face\" (http://quimby.gnus.org/circus/face/make-face)
  script

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.

Should I be quoting URLs in docstrings? Given that I usually quote
filenames, that might not be a bad way to go.

  Use the \"make-face\" (\"http://quimby.gnus.org/circus/face/make-face\")
  script

The following patch to checkdoc-this-string-valid-engine in checkdoc.el
avoids symbol matches immediately after a / and fixes the error I saw.
Is this OK?

Index: checkdoc.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/checkdoc.el,v
retrieving revision 1.51
diff -u -u -r1.51 checkdoc.el
--- checkdoc.el	24 Sep 2005 13:43:59 -0000	1.51
+++ checkdoc.el	27 Oct 2005 22:44:49 -0000
@@ -1802,7 +1803,7 @@
        (let ((found nil) (start (point)) (msg nil) (ms nil))
 	 (while (and (not msg)
 		     (re-search-forward
-		      "[^-([`':a-zA-Z]\\(\\w+[:-]\\(\\w\\|\\s_\\)+\\)[^]']"
+		      "[^-([`':/a-zA-Z]\\(\\w+[:-]\\(\\w\\|\\s_\\)+\\)[^]']"
 		      e t))
 	   (setq ms (match-string 1))
 	   (save-match-data


-- 
Bill Wohler <wohler@newt.com>  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.

             reply	other threads:[~2005-10-27 22:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-10-27 22:51 Bill Wohler [this message]
2005-10-28 16:17 ` checkdoc: URLs in docstrings with lisp symbols Richard M. Stallman
2005-10-28 22:01   ` Bill Wohler
2005-10-29  5:12     ` Richard M. Stallman
2005-10-31  1:30       ` Bill Wohler

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=31877.1130453516@olgas.newt.com \
    --to=wohler@newt.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).