Previous: , Up: Api   [Contents][Index]


5.16 Self-doc

Emacs offers a fantastic comprehensive help system. Emacsy intends to replicate most of this functionality. One distinction that would be nice to make is to partition Scheme values into procedures, variables, and parameters. In Scheme, all these kinds of values are the handled the same way. In Emacs, each are accessible by the help system distinctly. For instance, [[C-h f]] looks up functions, [[C-h v]] looks up variables. In addition to defining what kind of value a variable holds, this also allows one to include documentation for values which is not included in Guile Scheme by default. (XXX fact check.)

Scheme Procedure: variable-documentation variable-or-symbol

XXX Rename from variable-documentation to just documentation.

Scheme Procedure: emacsy-collect-kind module kind #:optional (depth 0)

We also want to be able to collect up all the variables in some given module.

Parameters behave similarly to variables; however, whenever they are defined, their values are set.