diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2021-08-27 17:13:00 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2021-08-27 17:15:17 +0200 |
| commit | 61323c6d765a478ffd8c659fe0e805814d9fecb1 (patch) | |
| tree | 11fc57b09f9db7436a1b8aab8e8eb2bd24e17466 /lisp/emacs-lisp/nadvice.el | |
| parent | d0693617b8dd986475cd7b96f20cdf2bfd27751e (diff) | |
| download | emacs-61323c6d765a478ffd8c659fe0e805814d9fecb1.tar.gz emacs-61323c6d765a478ffd8c659fe0e805814d9fecb1.tar.bz2 emacs-61323c6d765a478ffd8c659fe0e805814d9fecb1.zip | |
Put advice documentation at the end of the displayed doc string
* lisp/emacs-lisp/nadvice.el (advice--make-docstring): Put the
advice things at the end of the documentation (bug#50222). It's
important to have the first line of the original documentation
remain the first line, because it's used when doing one-line
summaries of the function.
Diffstat (limited to 'lisp/emacs-lisp/nadvice.el')
| -rw-r--r-- | lisp/emacs-lisp/nadvice.el | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/nadvice.el b/lisp/emacs-lisp/nadvice.el index 4804e859ebe..bb86fa1264e 100644 --- a/lisp/emacs-lisp/nadvice.el +++ b/lisp/emacs-lisp/nadvice.el @@ -119,7 +119,6 @@ Each element has the form (WHERE BYTECODE STACK) where: (or doc "No documentation"))))) "\n"))) (setq flist (advice--cdr flist))) - (if docstring (setq docstring (concat docstring "\n"))) (unless docfun (setq docfun flist)) (let* ((origdoc (unless (eq function docfun) ;Avoid inf-loops. (documentation docfun t))) @@ -131,7 +130,12 @@ Each element has the form (WHERE BYTECODE STACK) where: (if (stringp arglist) t (help--make-usage-docstring function arglist))) (setq origdoc (cdr usage)) (car usage))) - (help-add-fundoc-usage (concat docstring origdoc) usage)))) + (help-add-fundoc-usage (concat origdoc + (if (string-suffix-p "\n" origdoc) + "\n" + "\n\n") + docstring) + usage)))) (defun advice-eval-interactive-spec (spec) "Evaluate the interactive spec SPEC." |