(lispref.info)Format of Descriptions

Prev: Buffer Text Notation Up: Conventions

Format of Descriptions

   Functions, variables, macros, commands, user options, and special
forms are described in this manual in a uniform format.  The first line
of a description contains the name of the item followed by its
arguments, if any.

   The category--function, variable, or whatever--appears at the
beginning of the line.  The description follows on succeeding lines,
sometimes with examples.

* A Sample Function Description
A description of an imaginary function, `foo'.
* A Sample Variable Description
A description of an imaginary variable, `electric-future-map'.

automatically generated by info2www