From 19532d147b431a4fe34f088d6de07891c48e2c5c Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 1 Sep 2015 18:21:42 -0700 Subject: Escape ` and ' in doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- lisp/emacs-lisp/cl.el | 2 +- lisp/emacs-lisp/eieio.el | 4 ++-- lisp/emacs-lisp/eldoc.el | 4 ++-- lisp/emacs-lisp/gv.el | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) (limited to 'lisp/emacs-lisp') diff --git a/lisp/emacs-lisp/cl.el b/lisp/emacs-lisp/cl.el index 38deeaeaaa9..ba50680e8b9 100644 --- a/lisp/emacs-lisp/cl.el +++ b/lisp/emacs-lisp/cl.el @@ -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'. diff --git a/lisp/emacs-lisp/eieio.el b/lisp/emacs-lisp/eieio.el index 84c07d96c8d..ad178c3a2c2 100644 --- a/lisp/emacs-lisp/eieio.el +++ b/lisp/emacs-lisp/eieio.el @@ -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") diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index feffd5470c4..2dae86ebc95 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -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.") diff --git a/lisp/emacs-lisp/gv.el b/lisp/emacs-lisp/gv.el index bed9024e037..67609820a33 100644 --- a/lisp/emacs-lisp/gv.el +++ b/lisp/emacs-lisp/gv.el @@ -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) -- cgit v1.2.3