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

Add new hook to augment help buffers.

Browse source 
* help-fns.el (help-fns-describe-function-functions): New variable to
call functions for augmenting help buffers.
(describe-function-1): Remove explicit calls to
`help-fns--compiler-macro', `help-fns--parent-mode' and
`help-fns--obsolete'.  Put them in above new variable instead.  Call
all of them through `run-hook-with-args'.
This commit is contained in:
David Engster 2014-01-07 21:40:44 +01:00
parent 160006268a
commit abb82152dc
2 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
lisp/ChangeLog
View file

@ -1,3 +1,12 @@
2014-01-07 David Engster <deng@randomsample.de>
* help-fns.el (help-fns-describe-function-functions): New
variable to call functions for augmenting help buffers.
(describe-function-1): Remove explicit calls to
`help-fns--compiler-macro', `help-fns--parent-mode' and
`help-fns--obsolete'. Put them in above new variable instead.
Call all of them through `run-hook-with-args'.
2014-01-07 Martin Rudalics <rudalics@gmx.at>
* window.el (balance-windows-2): While rounding don't give a

17
lisp/help-fns.el
View file

@ -32,6 +32,12 @@
;;; Code:
(defvar help-fns-describe-function-functions nil
"List of functions to run in help buffer in `describe-function'.
Those functions will be run after the header line and argument
list was inserted, and before the documentation will be inserted.
The functions will receive the function name as argument.")
;; Functions
;;;###autoload
@ -649,14 +655,15 @@ FILE is the file where FUNCTION was probably defined."
(help-fns--key-bindings function)
(with-current-buffer standard-output
(setq doc (help-fns--signature function doc real-def real-function))
(help-fns--compiler-macro function)
(help-fns--parent-mode function)
(help-fns--obsolete function)
(run-hook-with-args 'help-fns-describe-function-functions function)
(insert "\n"
(or doc "Not documented.")))))))
;; Add defaults to `help-fns-describe-function-functions'.
(add-hook 'help-fns-describe-function-functions 'help-fns--obsolete)
(add-hook 'help-fns-describe-function-functions 'help-fns--parent-mode)
(add-hook 'help-fns-describe-function-functions 'help-fns--compiler-macro)
;; Variables