mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-22 18:35:09 +00:00
Code Issues Releases Activity

cl-generic.el: Upcase formal args in C-h o

Browse Source 
Try and improve the display of methods in `C-h o` by moving
the qualifiers to a separate line and upcasing the formal args.
It still needs love, tho.

* lisp/emacs-lisp/cl-generic.el: Upcase formal args in `C-h o`
(cl--generic-upcase-formal-args): New function.
(cl--generic-describe): Use it.
This commit is contained in:
Stefan Monnier 2022-04-25 15:41:04 -04:00
parent 4a1f69ebca
commit 0a151b7c29
1 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
lisp/emacs-lisp/cl-generic.el
View File

@ -1078,6 +1078,19 @@ MET-NAME is as returned by `cl--generic-load-hist-format'."
(setq combined-args (append (nreverse combined-args) args))
(list qual-string combined-args doconly)))
(defun cl--generic-upcase-formal-args (args)
(mapcar (lambda (arg)
(cond
((symbolp arg)
(let ((name (symbol-name arg)))
(if (eq ?& (aref name 0)) arg
(intern (upcase name)))))
((consp arg)
(cons (intern (upcase (symbol-name (car arg))))
(cdr arg)))
(t arg)))
args))
(add-hook 'help-fns-describe-function-functions #'cl--generic-describe)
(defun cl--generic-describe (function)
;; Supposedly this is called from help-fns, so help-fns should be loaded at
@ -1094,14 +1107,20 @@ MET-NAME is as returned by `cl--generic-load-hist-format'."
(insert (propertize "Implementations:\n\n" 'face 'bold))
;; Loop over fanciful generics
(dolist (method (cl--generic-method-table generic))
(let* ((info (cl--generic-method-info method)))
(pcase-let*
((`(,qualifiers ,args ,doc) (cl--generic-method-info method)))
;; FIXME: Add hyperlinks for the types as well.
(let ((print-quoted nil))
(if (length> (nth 0 info) 0)
(insert (format "%s%S" (nth 0 info) (nth 1 info)))
;; Make the non-":extra" bits look more like `C-h f'
;; output.
(insert (format "%S" (cons function (nth 1 info))))))
(let ((print-quoted nil)
(quals (if (length> qualifiers 0)
(concat (substring qualifiers
0 (string-match " *\\'"
qualifiers))
"\n")
"")))
(insert (format "%s%S"
quals
(cons function
(cl--generic-upcase-formal-args args)))))
(let* ((met-name (cl--generic-load-hist-format
function
(cl--generic-method-qualifiers method)
@ -1113,7 +1132,7 @@ MET-NAME is as returned by `cl--generic-load-hist-format'."
'help-function-def met-name file
'cl-defmethod)
(insert (substitute-command-keys "'.\n"))))
(insert "\n" (or (nth 2 info) "Undocumented") "\n\n")))))))
(insert "\n" (or doc "Undocumented") "\n\n")))))))
(defun cl--generic-specializers-apply-to-type-p (specializers type)
"Return non-nil if a method with SPECIALIZERS applies to TYPE."