bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#28267: 26.0.50; Perhaps `semantic-format-tag-custom-list' should use


From: Samuel Bronson
Subject: bug#28267: 26.0.50; Perhaps `semantic-format-tag-custom-list' should use `function-item' types?
Date: Mon, 28 Aug 2017 15:47:13 -0400

So, I was customizing the `speedbar' group, and I happened to notice
that the entries for `semantic-sb-button-format-tag-function' and
`semantic-sb-info-format-tag-function' offered extremely little in the
way of documentation, and while the docstrings for those variables could
do a better job of describing the contexts to which they are relevant,
the main difficulty is in knowing what the various choices mean.

A quick look in the vicinity of the functions' definitions revealed the
variable `semantic-format-tag-custom-list', which turns out to be where
the :type for those two settings comes from.  It is defined as follows:

Attachment: binajx8birr4a.bin
Description: application/emacs-lisp

It turns out that the documentation for `radio' types explicitly
mentions what we probably want here:

,----
| ‘(radio ELEMENT-TYPES...)’
|      This is similar to ‘choice’, except that the choices are displayed
|      using radio buttons rather than a menu.  This has the advantage of
|      displaying documentation for the choices when applicable and so is
|      often a good choice for a choice between constant functions
|      (‘function-item’ customization types).
`----

So it looks like we want to change the definition to:

Attachment: binMC0RNDyk6I.bin
Description: application/emacs-lisp

Or, in patch form,

--- a/lisp/cedet/semantic/format.el
+++ b/lisp/cedet/semantic/format.el
@@ -67,7 +67,7 @@
 
 (defvar semantic-format-tag-custom-list
   (append '(radio)
-         (mapcar (lambda (f) (list 'const f))
+         (mapcar (lambda (f) (list 'function-item f))
                  semantic-format-tag-functions)
          '(function))
   "A List used by customizable variables to choose a tag to text function.

Diff finished.  Mon Aug 28 15:42:17 2017

reply via email to

[Prev in Thread] Current Thread [Next in Thread]