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

Give , and .@ doc strings. Fixes bug #24561.

Browse source 
Also make *Help* links to ``' possible.  Also make usable as such doc strings
on the function-documentation property of a symbol.

* lisp/emacs-lisp/backquote.el (top-level): Give , and '@ doc strings on the
function-documentation property.  Also give these symbols a reader-construct
property.

* lisp/help-fns.el (describe-function): Allow the function-documentation
property to work.  Use princ rather than prin1 to print the function's name
when it has a reader-construct property.
(help-fns-signature): Don't insert `high-usage' for a reader-construct.
(describe-function-1): Adapt to process documentation on the
function-documentation property.  Print "a reader construct" when appropriate.

* lisp/help-mode.el (help-xref-symbol-regexp): Amend this regexp also to match
``'.
This commit is contained in:
Alan Mackenzie 2017-01-23 19:00:49 +00:00
parent 03de82fe7c
commit 0c31ff43b6
3 changed files with 35 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lisp/emacs-lisp/backquote.el
View file

@ -247,4 +247,14 @@ LEVEL is only used internally and indicates the nesting level:
tail))
(t (cons 'list heads)))))
;; Give `,' and `,@' documentation strings which can be examined by C-h f.
(put '\, 'function-documentation
"See `\\=`' (also `pcase') for the usage of `,'.")
(put '\, 'reader-construct t)
(put '\,@ 'function-documentation
"See `\\=`' for the usage of `,@'.")
(put '\,@ 'reader-construct t)
;;; backquote.el ends here