summaryrefslogtreecommitdiff
path: root/lisp/erc
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2015-09-01 18:21:42 -0700
committerPaul Eggert <eggert@cs.ucla.edu>2015-09-01 18:23:21 -0700
commit19532d147b431a4fe34f088d6de07891c48e2c5c (patch)
tree19baea54fefb82f849ed67e49a287a715fe050cc /lisp/erc
parent5dc644a6b01e2cf950ff617ab15be4bf1917c38c (diff)
downloademacs-19532d147b431a4fe34f088d6de07891c48e2c5c.tar.gz
Escape ` and ' in doc
Escape apostrophes and grave accents in docstrings if they are are supposed to stand for themselves and are not quotes. Remove apostrophes from docstring examples like ‘'(calendar-nth-named-day -1 0 10 year)’ that confuse source code with data. Do some other minor docstring fixups as well, e.g., insert a missing close quote.
Diffstat (limited to 'lisp/erc')
-rw-r--r--lisp/erc/erc-backend.el2
-rw-r--r--lisp/erc/erc-networks.el7
-rw-r--r--lisp/erc/erc-services.el2
-rw-r--r--lisp/erc/erc.el4
4 files changed, 7 insertions, 8 deletions
diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el
index db5f6a63519..eec69256db6 100644
--- a/lisp/erc/erc-backend.el
+++ b/lisp/erc/erc-backend.el
@@ -1082,7 +1082,7 @@ As an example:
Would expand to:
(prog2
- (defvar erc-server-311-functions 'erc-server-311
+ (defvar erc-server-311-functions \\='erc-server-311
\"Some non-generic variable documentation.
Hook called upon receiving a 311 server response.
diff --git a/lisp/erc/erc-networks.el b/lisp/erc/erc-networks.el
index 9de9b257c10..441663f3b3b 100644
--- a/lisp/erc/erc-networks.el
+++ b/lisp/erc/erc-networks.el
@@ -782,9 +782,9 @@ PORTS should be a list of either:
numbers between LOW and HIGH (inclusive) is returned.
As an example:
- (erc-ports-list '(1)) => (1)
- (erc-ports-list '((1 5))) => (1 2 3 4 5)
- (erc-ports-list '(1 (3 5))) => (1 3 4 5)"
+ (erc-ports-list \\='(1)) => (1)
+ (erc-ports-list \\='((1 5))) => (1 2 3 4 5)
+ (erc-ports-list \\='(1 (3 5))) => (1 3 4 5)"
(let (result)
(dolist (p ports)
(cond ((numberp p)
@@ -866,4 +866,3 @@ VALUE is the options value.")
;; indent-tabs-mode: t
;; tab-width: 8
;; End:
-
diff --git a/lisp/erc/erc-services.el b/lisp/erc/erc-services.el
index 07a4274dcb6..2d2fa6230c3 100644
--- a/lisp/erc/erc-services.el
+++ b/lisp/erc/erc-services.el
@@ -172,7 +172,7 @@ You can also use M-x erc-nickserv-identify-mode to change modes."
Example of use:
(setq erc-nickserv-passwords
- '((freenode ((\"nick-one\" . \"password\")
+ \\='((freenode ((\"nick-one\" . \"password\")
(\"nick-two\" . \"password\")))
(DALnet ((\"nick\" . \"password\")))))"
:group 'erc-services
diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index f2821798103..726e9ed9a21 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -927,7 +927,7 @@ If no elements match, then the empty string is used.
As an example:
(setq erc-quit-reason-various-alist
- '((\"xmms\" dme:now-playing)
+ \\='((\"xmms\" dme:now-playing)
(\"version\" erc-quit-reason-normal)
(\"home\" \"Gone home !\")
(\"^$\" \"Default Reason\")))
@@ -950,7 +950,7 @@ If no elements match, then the empty string is used.
As an example:
(setq erc-part-reason-various-alist
- '((\"xmms\" dme:now-playing)
+ \\='((\"xmms\" dme:now-playing)
(\"version\" erc-part-reason-normal)
(\"home\" \"Gone home !\")
(\"^$\" \"Default Reason\")))