mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Document X as "X", not as "(` X)"

Browse source 
* lisp/help.el (help-split-fundoc, help--make-usage-docstring):
Document (backquote FOO) as "`FOO", not as "(` FOO)" (Bug#20759).
This commit is contained in:
Paul Eggert 2015-06-12 16:27:42 -07:00
parent d4870a525d
commit 351739ba14
1 changed files with 17 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

29
lisp/help.el
View file

@ -1368,18 +1368,21 @@ DEF is the function whose usage we're looking for in DOCSTRING."
;; In cases where `function' has been fset to a subr we can't search for
;; function's name in the doc string so we use `fn' as the anonymous
;; function name instead.
(when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring))
(when (and docstring
(string-match "\n\n(fn\\(\\( +\\([^\n ]+\\( .*\\)?\\)?\\)?)\\)\\'"
docstring))
(let ((doc (unless (zerop (match-beginning 0))
(substring docstring 0 (match-beginning 0))))
(usage-tail (match-string 1 docstring)))
(cons (format "(%s%s"
;; Replace `fn' with the actual function name.
(if (symbolp def)
(help--docstring-quote
(substring (format "%S" (list def)) 1 -1))
'anonymous)
usage-tail)
doc))))
(substring docstring 0 (match-beginning 0)))))
(cons (if (and (eq def '\`) (match-beginning 3) (not (match-beginning 4)))
(concat "\\=`" (match-string 3 docstring))
(let ((usage-tail (match-string 1 docstring)))
(format "(%s%s"
;; Replace `fn' with the actual function name.
(if (symbolp def)
(help--docstring-quote (format "%S" def))
'anonymous)
usage-tail)))
doc))))
(defun help-add-fundoc-usage (docstring arglist)
"Add the usage info to DOCSTRING.
@ -1467,7 +1470,9 @@ the same names as used in the original source code, when possible."
(define-obsolete-function-alias 'help-make-usage 'help--make-usage "25.1")
(defun help--make-usage-docstring (fn arglist)
(help--docstring-quote (format "%S" (help--make-usage fn arglist))))
(help--docstring-quote
(let ((print-quoted (eq fn '\`)))
(format "%S" (help--make-usage fn arglist)))))
(provide 'help)