Re: [CEDET-devel] minor documentation issue

[Eric M. L. <er...@si...>]

On 11/12/2013 02:01 PM, Nate Schley wrote:
> Folks,
>
> I haven't investigated how the innards of the processes work, but when
> time permits, please consider adjusting the way text for the defvar's in
> loaddefs.el gets generated.
>
> Summary:  have the customize info for option `foo-mode' refer to the
> command `foo-mode' and not the command `global-foo-mode'.
>
> An example to illustrate the problem:
>
>     * I want to change the value of something.  While poking around the
>       customize browser, I find Global-Semantic-Highlight-Edits
>     * The description for this says, "See the command
>       `global-semantic-highlight-edits-mode' for a description ...."
>     * So I do ^H-k to bring up the *Help* buffer
>       for global-semantic-highlight-edits-mode.  This just says, "Toggle
>       global use of option `semantic-highlight-edits-mode'."  (well, duh!)
>     * Note:  the uninitiated may observe `...-mode' is an option,
>       suggesting the variable definition should be pursued, and so will
>       want to use ^H-v on `semantic-highlight-edits-mode'.  They
>       will enter a circular loop of cross-references.
>     * I, however, have been initiated, so I use ^H-k
>       on `semantic-highlight-edits-mode' and I arrive at the desired
>       pool of knowledge.

Hi Nate,

Sorry for a really slow reply.

I wasn't sure what to make of this when I first read it, and I'm still 
not sure what to do about it.   When I customize a mode, such as 
global-semantic-highlight-edits, the resultant customize buffer doesn't 
even show the doc that is written near our declaration, which points 
directly ad the function with all the doc on it.

Does anyone on the list know how to better control what doc shows up in 
a customize buffer when using define-minor-mode?

Thanks
Eric