GNU bug report logs - #52741
27.2; Doc string of `visual-line-mode'

Previous Next

Full log

Message #19 received at 52741 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: "rms <at> gnu.org" <rms <at> gnu.org>
Cc: "52741 <at> debbugs.gnu.org" <52741 <at> debbugs.gnu.org>
Subject: RE: [External] : Re: bug#52741: 27.2; Doc string of `visual-line-mode'
Date: Fri, 24 Dec 2021 05:32:52 +0000

> > What on earth is ARG, for interactive use?  The description of
> > interactive use should talk about things like a prefix arg, not about
> > unexplained things like ARG.  How will a user know how to pass argument
> > ARG interactively?
> 
> It's standard -- every user should know how to give a command a numeric arg.

Sure.  But the doc string normally says, "With a
prefix arg...", or "A numeric prefix arg means...".
or some such.

It doesn't talk about an undescribed ARG in the
context of interactive use.  If it talks about ARG
in that context, it tells you it's the prefix arg.

This is the relevant part of the doc string in
question, for Emacs 27.2, which is what I reported on:

 If called interactively, enable Visual-Line mode if
 ARG is positive, and disable it if ARG is zero or
 negative.

What's missing there is "prefix" or (preferably)
"numeric prefix", before "ARG" (or "arg").

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.