all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Kevin Ryde <user42@zip.com.au>
To: emacs-pretest-bug@gnu.org
Subject: bug#3864: 23.1.50; docstring url hyperlinks
Date: Thu, 16 Jul 2009 10:43:20 +1000	[thread overview]
Message-ID: <87iqhta253.fsf@blah.blah> (raw)

[-- Attachment #1: Type: text/plain, Size: 928 bytes --]

I did a grep for urls in docstrings which might be hyperlinked.
Diff below from the lisp directory.

It'd be tempting to have M-x checkdoc report on this sort of
thing, except it may too often hit sample input etc instead of
actual followable links.


2009-07-16  Kevin Ryde  <user42@zip.com.au>

	* erc/erc.el (erc-cmd-MODE): 
	* mh-e/mh-junk.el (mh-spamassassin-blacklist,
	mh-bogofilter-blacklist, mh-spamprobe-blacklist): 
	* net/newst-backend.el (newsticker--parse-atom-1.0,
	newsticker--parse-rss-0.91, newsticker--parse-rss-0.92,
	newsticker--parse-rss-1.0):
	* progmodes/idlwave.el (idlwave-mode): 
	* progmodes/idlw-shell.el (idlwave-shell-mode): 
	* progmodes/vera-mode.el (vera-mode): 
	* progmodes/verilog-mode.el (verilog-auto-inst, verilog-auto): 
	* progmodes/vhdl-mode.el (vhdl-mode): 
	* textmodes/table.el (table-generate-source)
	(table--warn-incompatibility): 
	Hyperlink urls in docstrings with URL `...'.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: docstring-urls.diff --]
[-- Type: text/x-diff, Size: 9689 bytes --]

Index: erc/erc.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/erc/erc.el,v
retrieving revision 1.60
diff -u -r1.60 erc.el
--- erc/erc.el	13 Mar 2009 20:45:14 -0000	1.60
+++ erc/erc.el	16 Jul 2009 00:34:41 -0000
@@ -3095,7 +3095,7 @@
 If only one word is given, display the mode of that target.
 
 A list of valid mode strings for Freenode may be found at
-`http://freenode.net/using_the_network.shtml'."
+URL `http://freenode.net/using_the_network.shtml'."
   (cond
    ((string-match "^\\s-\\(.*\\)$" line)
     (let ((s (match-string 1 line)))
Index: mh-e/mh-junk.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/mh-e/mh-junk.el,v
retrieving revision 1.28
diff -u -r1.28 mh-junk.el
--- mh-e/mh-junk.el	10 Jan 2009 21:50:42 -0000	1.28
+++ mh-e/mh-junk.el	16 Jul 2009 00:34:43 -0000
@@ -109,7 +109,7 @@
 
 SpamAssassin is one of the more popular spam filtering programs.
 Get it from your local distribution or from
-http://spamassassin.org/.
+URL `http://spamassassin.org/'.
 
 To use SpamAssassin, add the following recipes to
 \".procmailrc\":
@@ -332,7 +332,7 @@
   "Blacklist MSG with bogofilter.
 
 Bogofilter is a Bayesian spam filtering program. Get it from your
-local distribution or from http://bogofilter.sourceforge.net/.
+local distribution or from URL `http://bogofilter.sourceforge.net/'.
 
 Bogofilter is taught by running:
 
@@ -412,7 +412,7 @@
   "Blacklist MSG with SpamProbe.
 
 SpamProbe is a Bayesian spam filtering program. Get it from your local
-distribution or from http://spamprobe.sourceforge.net.
+distribution or from URL `http://spamprobe.sourceforge.net'.
 
 To use SpamProbe, add the following recipes to \".procmailrc\":
 
Index: net/newst-backend.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/net/newst-backend.el,v
retrieving revision 1.8
diff -u -r1.8 newst-backend.el
--- net/newst-backend.el	23 Jan 2009 18:49:06 -0000	1.8
+++ net/newst-backend.el	16 Jul 2009 00:34:50 -0000
@@ -1130,7 +1130,7 @@
 contains the feed data as returned by the xml parser.
 
 For the Atom 1.0 specification see
-http://www.atompub.org/2005/08/17/draft-ietf-atompub-format-11.html"
+URL `http://www.atompub.org/2005/08/17/draft-ietf-atompub-format-11.html'"
   (newsticker--debug-msg "Parsing Atom 1.0 feed %s" name)
   (let (new-feed new-item)
     (setq new-feed (newsticker--parse-generic-feed
@@ -1184,8 +1184,8 @@
 Return value as well as arguments NAME, TIME, and TOPNODE are the
 same as in `newsticker--parse-atom-1.0'.
 
-For the RSS 0.91 specification see http://backend.userland.com/rss091 or
-http://my.netscape.com/publish/formats/rss-spec-0.91.html."
+For the RSS 0.91 specification see URL `http://backend.userland.com/rss091'
+or URL `http://my.netscape.com/publish/formats/rss-spec-0.91.html'."
   (newsticker--debug-msg "Parsing RSS 0.91 feed %s" name)
   (let* ((channelnode (car (xml-get-children topnode 'channel)))
          (pub-date (newsticker--decode-rfc822-date
@@ -1238,7 +1238,7 @@
 Return value as well as arguments NAME, TIME, and TOPNODE are the
 same as in `newsticker--parse-atom-1.0'.
 
-For the RSS 0.92 specification see http://backend.userland.com/rss092."
+For the RSS 0.92 specification see URL `http://backend.userland.com/rss092'."
   (newsticker--debug-msg "Parsing RSS 0.92 feed %s" name)
   (let* ((channelnode (car (xml-get-children topnode 'channel)))
          (pub-date (newsticker--decode-rfc822-date
@@ -1291,7 +1291,7 @@
 Return value as well as arguments NAME, TIME, and TOPNODE are the
 same as in `newsticker--parse-atom-1.0'.
 
-For the RSS 1.0 specification see http://web.resource.org/rss/1.0/spec."
+For the RSS 1.0 specification see URL `http://web.resource.org/rss/1.0/spec'."
   (newsticker--debug-msg "Parsing RSS 1.0 feed %s" name)
   (let* ((channelnode (car (xml-get-children topnode 'channel)))
          is-new-feed has-new-items)
@@ -1342,7 +1342,7 @@
 Return value as well as arguments NAME, TIME, and TOPNODE are the
 same as in `newsticker--parse-atom-1.0'.
 
-For the RSS 2.0 specification see http://blogs.law.harvard.edu/tech/rss."
+For the RSS 2.0 specification see URL `http://blogs.law.harvard.edu/tech/rss'."
   (newsticker--debug-msg "Parsing RSS 2.0 feed %s" name)
   (let* ((channelnode (car (xml-get-children topnode 'channel)))
          is-new-feed has-new-items)
Index: progmodes/idlw-shell.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/progmodes/idlw-shell.el,v
retrieving revision 3.66
diff -u -r3.66 idlw-shell.el
--- progmodes/idlw-shell.el	5 Jan 2009 03:23:41 -0000	3.66
+++ progmodes/idlw-shell.el	16 Jul 2009 00:35:07 -0000
@@ -941,7 +941,7 @@
    Info documentation for this package is available.  Use \\[idlwave-info]
    to display (complain to your sysadmin if that does not work).
    For Postscript and HTML versions of the documentation, check IDLWAVE's
-   homepage at `http://idlwave.org'.
+   homepage at URL `http://idlwave.org'.
    IDLWAVE has customize support - see the group `idlwave'.
 
 8. Keybindings
Index: progmodes/idlwave.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/progmodes/idlwave.el,v
retrieving revision 3.77
diff -u -r3.77 idlwave.el
--- progmodes/idlwave.el	9 Jan 2009 04:15:59 -0000	3.77
+++ progmodes/idlwave.el	16 Jul 2009 00:35:40 -0000
@@ -1883,7 +1883,7 @@
    Info documentation for this package is available.  Use
    \\[idlwave-info] to display (complain to your sysadmin if that does
    not work).  For Postscript, PDF, and HTML versions of the
-   documentation, check IDLWAVE's homepage at `http://idlwave.org'.
+   documentation, check IDLWAVE's homepage at URL `http://idlwave.org'.
    IDLWAVE has customize support - see the group `idlwave'.
 
 10.Keybindings
Index: progmodes/vera-mode.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/progmodes/vera-mode.el,v
retrieving revision 1.14
diff -u -r1.14 vera-mode.el
--- progmodes/vera-mode.el	9 Jan 2009 04:16:03 -0000	1.14
+++ progmodes/vera-mode.el	16 Jul 2009 00:35:45 -0000
@@ -291,7 +291,7 @@
 Feel free to send questions and enhancement requests to <reto@gnu.org>.
 
 Official distribution is at
-<http://www.iis.ee.ethz.ch/~zimmi/emacs/vera-mode.html>.
+URL `http://www.iis.ee.ethz.ch/~zimmi/emacs/vera-mode.html'
 
 
                                                   The Vera Mode Maintainer
Index: progmodes/verilog-mode.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/progmodes/verilog-mode.el,v
retrieving revision 1.29
diff -u -r1.29 verilog-mode.el
--- progmodes/verilog-mode.el	6 Jul 2009 08:32:53 -0000	1.29
+++ progmodes/verilog-mode.el	16 Jul 2009 00:36:20 -0000
@@ -8811,7 +8811,7 @@
   Unless you are instantiating a module multiple times, or the module is
   something trivial like an adder, DO NOT CHANGE SIGNAL NAMES ACROSS HIERARCHY.
   It just makes for unmaintainable code.  To sanitize signal names, try
-  vrename from http://www.veripool.org.
+  vrename from URL `http://www.veripool.org'.
 
   When you need to violate this suggestion there are two ways to list
   exceptions, placing them before the AUTOINST, or using templates.
@@ -10503,7 +10503,7 @@
     `verilog-read-includes'     for reading `includes
 
 If you have bugs with these autos, please file an issue at
-http://www.veripool.org/verilog-mode or contact the AUTOAUTHOR
+URL `http://www.veripool.org/verilog-mode' or contact the AUTOAUTHOR
 Wilson Snyder (wsnyder@wsnyder.org)."
   (interactive)
   (unless noninteractive (message "Updating AUTOs..."))
Index: progmodes/vhdl-mode.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/progmodes/vhdl-mode.el,v
retrieving revision 1.81
diff -u -r1.81 vhdl-mode.el
--- progmodes/vhdl-mode.el	2 Feb 2009 20:49:44 -0000	1.81
+++ progmodes/vhdl-mode.el	16 Jul 2009 00:37:08 -0000
@@ -4648,7 +4648,7 @@
 to above mailing lists by sending an email to <reto@gnu.org>.
 
 VHDL Mode is officially distributed at
-http://opensource.ethz.ch/emacs/vhdl-mode.html
+URL `http://opensource.ethz.ch/emacs/vhdl-mode.html'
 where the latest version can be found.
 
 
Index: textmodes/table.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/textmodes/table.el,v
retrieving revision 1.40
diff -u -r1.40 table.el
--- textmodes/table.el	26 May 2009 03:32:03 -0000	1.40
+++ textmodes/table.el	16 Jul 2009 00:37:27 -0000
@@ -3002,14 +3002,14 @@
 References used for this implementation:
 
 HTML:
-        http://www.w3.org
+        URL `http://www.w3.org'
 
 LaTeX:
-        http://www.maths.tcd.ie/~dwilkins/LaTeXPrimer/Tables.html
+        URL `http://www.maths.tcd.ie/~dwilkins/LaTeXPrimer/Tables.html'
 
 CALS (DocBook DTD):
-        http://www.oasis-open.org/html/a502.htm
-        http://www.oreilly.com/catalog/docbook/chapter/book/table.html#AEN114751
+        URL `http://www.oasis-open.org/html/a502.htm'
+        URL `http://www.oreilly.com/catalog/docbook/chapter/book/table.html#AEN114751'
 "
   (interactive
    (let* ((dummy (unless (table--probe-cell) (error "Table not found here")))
@@ -5369,7 +5369,7 @@
 *** Warning ***
 
 Flyspell minor mode is known to be incompatible with this table
-package.  The flyspell version 1.5d at http://kaolin.unice.fr/~serrano
+package.  The flyspell version 1.5d at URL `http://kaolin.unice.fr/~serrano'
 works better than the previous versions however not fully compatible.
 
 "

             reply	other threads:[~2009-07-16  0:43 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <jeis9wh39.fsf@fencepost.gnu.org>
2009-07-16  0:43 ` Kevin Ryde [this message]
2009-07-22  3:15   ` bug#3864: marked as done (23.1.50; docstring url hyperlinks) Emacs bug Tracking System
2009-07-22  3:36     ` Leo

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

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

  git send-email \
    --in-reply-to=87iqhta253.fsf@blah.blah \
    --to=user42@zip.com.au \
    --cc=3864@emacsbugs.donarmstrong.com \
    --cc=emacs-pretest-bug@gnu.org \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.