🚀 go-pugleaf

>>>>> In article "On-line documentation for buffer-locals", "Jonas" ==
>>>>> jonas@ericad.ericsson.SE (Jonas Jaernestroem TG/HK) writes:

Jonas> In Emacs 18.57 on a Sun Sparc SLC running 4.1.1 BSD.

Jonas> When maintaining or using somebodys (for example your own) elisp
Jonas> code, the on-line documentation strings on defuns and global
Jonas> variables (defvar & defconst) are a true delight.

Jonas> However I miss this capability on buffer-local variables, which I
Jonas> say are at least as important to document as the global ones. In
Jonas> my view, this makes buffer-local variables less pleasant to use
Jonas> than global variables, which I guess was not the implementors
Jonas> intention.

Jonas> In other words, I would like make-local-variable to have an
Jonas> optional second argument for the document string.

`make-local-variable' simply gives the variable a separate VALUE in the
buffer.  The symbol retains its other properties, including its
documentation string.  You can therefore do something like:-

(defvar my-variable nil "Documentation string")

...

(defun foobar-mode ()
  ...
  (make-local-variable 'my-variable)
  (setq my-variable 'wibble)
  ...

When you do  C-h v my-variable RET  the *Help* window will show the
value associated with the current buffer and the documentation string
specified in the `defvar'.

--
Kevin Broadey <kbroadey@edscom.demon.co.uk>
EDS-Scicon, Wavendon Tower, Wavendon, Milton Keynes, MK17 8LX, England.
Phone: +44 908 284198 (direct) or +44 908 585858 ext 4198
These opinions are mine: others available on request.