procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Escape ` and ' in doc

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

4
lisp/emacs-lisp/eldoc.el
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.")