Commit 798f07f1 authored by Philipp Stephani's avatar Philipp Stephani

Document that mode commands should be idempotent.

* doc/lispref/modes.texi (Major Mode Conventions, Minor Mode
Conventions): Document that the mode commands should be idempotent.
parent ad2a47ce
......@@ -313,6 +313,11 @@ The major mode command should set the variable @code{mode-name} to the
Data}, for other possible forms). The name of the mode appears
in the mode line.
@item
Calling the major mode command twice in direct succession should not
fail and should do the same thing as calling the command only once.
In other words, the major mode command should be idempotent.
@item
@cindex functions in modes
Since all global names are in the same name space, all the global
......@@ -1412,6 +1417,10 @@ a minor mode in a mode hook is a little uglier:
@noindent
However, this is not very commonly done.
Enabling or disabling a minor mode twice in direct succession should
not fail and should do the same thing as enabling or disabling it only
once. In other words, the minor mode command should be idempotent.
@item
Add an element to @code{minor-mode-alist} for each minor mode
(@pxref{Definition of minor-mode-alist}), if you want to indicate the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment