1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-03 10:31:37 -08:00

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.
This commit is contained in:
Paul Eggert 2015-09-01 18:21:42 -07:00
parent 5dc644a6b0
commit 19532d147b
43 changed files with 127 additions and 128 deletions

View file

@ -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.

View file

@ -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:

View file

@ -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

View file

@ -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\")))