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

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

Re: Passing user selection to a command


From: Stefan Monnier
Subject: Re: Passing user selection to a command
Date: Tue, 19 Mar 2024 12:11:46 -0400
User-agent: Gnus/5.13 (Gnus v5.13)

> The documentation for activate-input-method says
>
> "If some other input method is already active, turn it off first."
>
> It is not very clear whether the user should turn it off, or whether the
> activate-input-method function will turn INPUT-METHOD off automatically.

It becomes more clear once you're familiar with the way docstrings are
written: they usually describe what the function does rather than what
the caller should do.  So when they say something about what the caller
should do, they usually do so explicitly.

IOW, if the user needs to turn it off first, the docstring would say
something like "some other IM should not be already active" or "if some
other IM is already active, do nothing".


        Stefan




reply via email to

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