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

(advice--make-nadvice-docstring): Rename

Browse source 
* lisp/emacs-lisp/nadvice.el (advice--make-nadvice-docstring): Rename
from `nadvice--make-docstring`, to stick to the `advice-` namespace.
Update all callers.
This commit is contained in:
Stefan Monnier 2025-03-03 22:18:02 -05:00
parent 93c3a269ca
commit 035077febe
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lisp/emacs-lisp/nadvice.el
View file

@ -151,7 +151,8 @@ DOC is a string where \"FUNCTION\" and \"OLDFUN\" are expected.")
;; definition is loaded]", bug#21299
(if (stringp arglist) t
(help--make-usage-docstring function arglist)))
(setq origdoc (cdr usage)) (car usage)))
(setq origdoc (cdr usage))
(car usage)))
(help-add-fundoc-usage
(with-temp-buffer
(when before
@ -319,7 +320,10 @@ These functions act like the t special value in buffer-local hooks.")
((symbolp place) `(default-value ',place))
(t place))))
(defun nadvice--make-docstring (sym)
(defun advice--make-nadvice-docstring (sym)
"Make docstring for a nadvice function.
Modifies the function's docstring by replacing \"<<>>\" with the
description of the possible HOWs."
(let* ((main (documentation (symbol-function sym) 'raw))
(ud (help-split-fundoc main 'pcase))
(doc (or (cdr ud) main))
@ -340,7 +344,7 @@ These functions act like the t special value in buffer-local hooks.")
(if ud (help-add-fundoc-usage combined-doc (car ud)) combined-doc)))
(put 'add-function 'function-documentation
'(nadvice--make-docstring 'add-function))
'(advice--make-nadvice-docstring 'add-function))
;;;###autoload
(defmacro add-function (how place function &optional props)
@ -498,7 +502,7 @@ of the piece of advice."
(funcall fsetfun symbol newdef))))
(put 'advice-add 'function-documentation
'(nadvice--make-docstring 'advice-add))
'(advice--make-nadvice-docstring 'advice-add))
;;;###autoload
(defun advice-add (symbol how function &optional props)