diff options
| author | Paul Eggert <eggert@cs.ucla.edu> | 2015-06-13 09:35:10 -0700 |
|---|---|---|
| committer | Paul Eggert <eggert@cs.ucla.edu> | 2015-06-13 09:35:46 -0700 |
| commit | 8afef016e2bc413c7a4913554ea6ed2c55474de6 (patch) | |
| tree | dddc5194079a7a04941838ef9ab0626cf30daf90 /lisp/help.el | |
| parent | eb92f89c2125aaf8fdf93cdd85ab46ae278dd950 (diff) | |
| download | emacs-8afef016e2bc413c7a4913554ea6ed2c55474de6.tar.gz | |
Better fix for documenting `X as "`X"
Fix suggested by Stefan Monnier.
* lisp/help-fns.el (help-fns--signature):
Insert "`X", not "(\` X)", when documenting `X (Bug#20759).
* lisp/help.el (help-split-fundoc, help--make-usage-docstring):
Don't treat `X specially, as help-fns--signature now handles this.
Diffstat (limited to 'lisp/help.el')
| -rw-r--r-- | lisp/help.el | 28 |
1 files changed, 11 insertions, 17 deletions
diff --git a/lisp/help.el b/lisp/help.el index d24fbfd64ec..2bf53c09b05 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -1368,21 +1368,17 @@ 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\\(\\( +\\([^\n ]+\\( .*\\)?\\)?\\)?)\\)\\'" - docstring)) + (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring)) (let ((doc (unless (zerop (match-beginning 0)) - (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)))) + (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 (format "%S" def)) + 'anonymous) + usage-tail) + doc)))) (defun help-add-fundoc-usage (docstring arglist) "Add the usage info to DOCSTRING. @@ -1470,9 +1466,7 @@ 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 - (let ((print-quoted (eq fn '\`))) - (format "%S" (help--make-usage fn arglist))))) + (help--docstring-quote (format "%S" (help--make-usage fn arglist)))) (provide 'help) |