diff options
author | Alan Mackenzie <acm@muc.de> | 2017-01-23 19:00:49 +0000 |
---|---|---|
committer | Alan Mackenzie <acm@muc.de> | 2017-01-23 19:00:49 +0000 |
commit | 0c31ff43b6880c84498fbe1f06e1e5809b55e838 (patch) | |
tree | d1a737ed59f7d58af3f7d5eda3fef8022291fd2e /lisp/emacs-lisp/backquote.el | |
parent | 03de82fe7ca09ab40fbcae394d4fcdfe3374496e (diff) | |
download | emacs-0c31ff43b6880c84498fbe1f06e1e5809b55e838.tar.gz |
Give , and .@ doc strings. Fixes bug #24561.
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
``'.
Diffstat (limited to 'lisp/emacs-lisp/backquote.el')
-rw-r--r-- | lisp/emacs-lisp/backquote.el | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lisp/emacs-lisp/backquote.el b/lisp/emacs-lisp/backquote.el index 94c561cba0a..bb877dd2c97 100644 --- a/lisp/emacs-lisp/backquote.el +++ b/lisp/emacs-lisp/backquote.el @@ -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 |