Subject: Re: bug#18192: Incorrect implication in delete-{backward,forward}-char docstrings

From: Lars Ingebrigtsen <[email-masked]>
Date: Sat, 03 Aug 2019 21:13:54 +0200

Reuben Thomas <[email-masked]> writes:

> These two functions are marked interactive-only, yet the docstrings' last
> sentence starts "Interactively," which may lead readers to infer that they can
> be used non-interactively:
>
> Interactively, N is the prefix arg, and
> KILLFLAG is set if N was explicitly specified.
>
> How about the following re-wording for the last sentence:
>
> "A prefix arg becomes N, and sets KILLFLAG."
>
> In fact, this solves another confusion: is pressing C-u "explicitly" setting N?
> It might seem not, but it certainly causes KILLFLAG to be set.

It a bit confusingly worded, and I've now installed the following phrase
instead:

"If called interactively, a numeric prefix argument specifies N, and
KILLFLAG is also set if a prefix argument is used."

While these functions are just supposed to be used interactively, they
can be used non-interactively, so I think it's right to call out the "if
called interactively" here, too.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no