[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
checkdoc: URLs in docstrings with lisp symbols
From: |
Bill Wohler |
Subject: |
checkdoc: URLs in docstrings with lisp symbols |
Date: |
Thu, 27 Oct 2005 15:51:56 -0700 |
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 <address@hidden> 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.
- checkdoc: URLs in docstrings with lisp symbols,
Bill Wohler <=