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

@ -568,7 +568,7 @@ may be bound to temporary variables which are introduced
automatically to preserve proper execution order of the arguments.
For example:
(defsetf nth (n x) (v) `(setcar (nthcdr ,n ,x) ,v))
(defsetf nth (n x) (v) \\=`(setcar (nthcdr ,n ,x) ,v))
You can replace this form with `gv-define-setter'.

View file

@ -683,12 +683,12 @@ This class is not stored in the `parent' slot of a class vector."
"Make a new instance of CLASS based on INITARGS.
For example:
(make-instance 'foo)
(make-instance \\='foo)
INITARGS is a property list with keywords based on the `:initarg'
for each slot. For example:
(make-instance 'foo :slot1 value1 :slotN valueN)")
(make-instance \\='foo :slot1 value1 :slotN valueN)")
(define-obsolete-function-alias 'constructor #'make-instance "25.1")

View file

@ -337,8 +337,8 @@ and the face `eldoc-highlight-function-argument', if they are to have any
effect.
Major modes should modify this variable using `add-function', for example:
(add-function :before-until (local 'eldoc-documentation-function)
#'foo-mode-eldoc-function)
(add-function :before-until (local \\='eldoc-documentation-function)
#\\='foo-mode-eldoc-function)
so that the global documentation function (i.e. the default value of the
variable) is taken into account if the major mode specific function does not
return any documentation.")

View file

@ -218,7 +218,7 @@ return a Lisp form that does the assignment.
The first arg in ARGLIST (the one that receives VAL) receives an expression
which can do arbitrary things, whereas the other arguments are all guaranteed
to be pure and copyable. Example use:
(gv-define-setter aref (v a i) `(aset ,a ,i ,v))"
(gv-define-setter aref (v a i) \\=`(aset ,a ,i ,v))"
(declare (indent 2) (debug (&define name sexp body)))
`(gv-define-expander ,name
(lambda (do &rest args)