bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#24706: 26.0.50; Minor mode functions should do strict argument type


From: Philipp Stephani
Subject: bug#24706: 26.0.50; Minor mode functions should do strict argument type checking
Date: Sun, 23 Apr 2017 17:51:32 +0000



Eli Zaretskii <eliz@gnu.org> schrieb am So., 16. Okt. 2016 um 20:51 Uhr:
> From: Philipp Stephani <p.stephani2@gmail.com>
> Date: Sun, 16 Oct 2016 18:25:08 +0000
>
> Attached a patch that uses the wording from `define-minor-mode'.

The patch for the ELisp manual simply rearranges the same words, so
it's not clear to me why we would prefer it to what's already there.

As for the doc string, please avoid repetition, it's confusing.  I
suggested to describe the additional features when the mode is called
from Lisp by using the word "also".


I don't think there's any repetition or rearranging here. The key difference is that when called from Lisp with an argument that is neither nil nor an integer, the mode is also enabled. That isn't possible for interactive calls because the argument is always a number.
Maybe something like

"With a prefix argument ARG, enable the mode if ARG is positive, and disable it if ARG is negative or zero. Additionally, when called from Lisp, toggle the mode if ARG is the symbol `toggle' and interpret ARG as defined by `prefix-numeric-value' otherwise."

(and then document the behavior of prefix-numeric-value)

reply via email to

[Prev in Thread] Current Thread [Next in Thread]