Using describe-variable

Using describe-variable

[Heime]

I want to add some additional documentation for users of a minor-mode.  Started 
with using a "defconst", and call "describe-variable".  I can either put the 
information in the variable itself, or in its documentation.  

(defconst gali-minicompl
  "Minibuffer completion is a powerful instrument that reduces typing
and saves time by efficiently completing commands, file paths, function
names, variables, and more."

"Describe Minibuffer Completion."
)

(defun gali-navi-minicompl ()
  "Provide information about using Minibuffer Completion."
  (interactive)
  (describe-variable 'gali-minicompl))

Another thing to mention is that "describe-variable" displays the variable
documentation first, followed by its value. 

At times it can be convenient to have the value printed first, followed by 
its documentation string.  And to refrain from printing either the value or
its description.

Re: Using describe-variable

[Stefan Monnier via Users list for the GNU Emacs text editor]

> I want to add some additional documentation for users of a minor-mode.

Put it in the docstring of the mode.


        Stefan