diff options
| author | Paul Eggert <eggert@cs.ucla.edu> | 2015-09-01 18:21:42 -0700 |
|---|---|---|
| committer | Paul Eggert <eggert@cs.ucla.edu> | 2015-09-01 18:23:21 -0700 |
| commit | 19532d147b431a4fe34f088d6de07891c48e2c5c (patch) | |
| tree | 19baea54fefb82f849ed67e49a287a715fe050cc /lisp/emacs-lisp/eldoc.el | |
| parent | 5dc644a6b01e2cf950ff617ab15be4bf1917c38c (diff) | |
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/emacs-lisp/eldoc.el')
| -rw-r--r-- | lisp/emacs-lisp/eldoc.el | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index feffd5470c..2dae86ebc9 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.") |