* bug#10346: 24.0.92; doc string of `save-buffer'
@ 2011-12-21 22:15 Drew Adams
2012-09-17 0:19 ` Drew Adams
2014-02-09 5:35 ` Lars Ingebrigtsen
0 siblings, 2 replies; 6+ messages in thread
From: Drew Adams @ 2011-12-21 22:15 UTC (permalink / raw)
To: 10346
Please describe the optional argument ARGS (which should be called ARG,
BTW, since it is not &rest and it is not a cons in general).
The doc string talks about the prefix arg, but no connection is made to
ARGS for use in Lisp.
Furthermore, "With a numeric argument of 0" is incorrect and misleads.
For an interactive user, this should be stated in terms of the numeric
value of the prefix argument, not just "a numeric argument".
In general, reread the doc string, and I'm sure you will see that it
could be improved wrt describing the use of a prefix arg and the use of
the argument from Lisp.
In GNU Emacs 24.0.92.1 (i386-mingw-nt5.1.2600) of 2011-12-06 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.6) --no-opt --cflags
-ID:/devel/emacs/libs/libXpm-3.5.8/include
-ID:/devel/emacs/libs/libXpm-3.5.8/src
-ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
-ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
-ID:/devel/emacs/libs/giflib-4.1.4-1/include
-ID:/devel/emacs/libs/jpeg-6b-4/include
-ID:/devel/emacs/libs/tiff-3.8.2-1/include
-ID:/devel/emacs/libs/gnutls-2.10.1/include --ldflags
-LD:/devel/emacs/libs/gnutls-2.10.1/lib'
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#10346: 24.0.92; doc string of `save-buffer'
2011-12-21 22:15 bug#10346: 24.0.92; doc string of `save-buffer' Drew Adams
@ 2012-09-17 0:19 ` Drew Adams
2014-02-09 5:35 ` Lars Ingebrigtsen
1 sibling, 0 replies; 6+ messages in thread
From: Drew Adams @ 2012-09-17 0:19 UTC (permalink / raw)
To: 10346
ping
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#10346: 24.0.92; doc string of `save-buffer'
2011-12-21 22:15 bug#10346: 24.0.92; doc string of `save-buffer' Drew Adams
2012-09-17 0:19 ` Drew Adams
@ 2014-02-09 5:35 ` Lars Ingebrigtsen
2014-02-11 15:02 ` Drew Adams
2016-04-28 11:58 ` Lars Ingebrigtsen
1 sibling, 2 replies; 6+ messages in thread
From: Lars Ingebrigtsen @ 2014-02-09 5:35 UTC (permalink / raw)
To: Drew Adams; +Cc: 10346
"Drew Adams" <drew.adams@oracle.com> writes:
> Please describe the optional argument ARGS (which should be called ARG,
> BTW, since it is not &rest and it is not a cons in general).
Fixed on trunk.
> The doc string talks about the prefix arg, but no connection is made to
> ARGS for use in Lisp.
Yes. But the values for ARG are so... non-Lispey, I have a feeling
that it's been left off by choice. The values are basically 0, 4, 16
and 64, which are ... kinda opaque when calling a function like that.
I don't know. Should these values be documented or not?
> Furthermore, "With a numeric argument of 0" is incorrect and misleads.
> For an interactive user, this should be stated in terms of the numeric
> value of the prefix argument, not just "a numeric argument".
Fixed on trunk.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#10346: 24.0.92; doc string of `save-buffer'
2014-02-09 5:35 ` Lars Ingebrigtsen
@ 2014-02-11 15:02 ` Drew Adams
2016-04-28 11:58 ` Lars Ingebrigtsen
1 sibling, 0 replies; 6+ messages in thread
From: Drew Adams @ 2014-02-11 15:02 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: 10346
> > The doc string talks about the prefix arg, but no connection is
> > made to ARGS for use in Lisp.
>
> Yes. But the values for ARG are so... non-Lispey, I have a feeling
> that it's been left off by choice. The values are basically 0, 4,
> 16 and 64, which are ... kinda opaque when calling a function like
> that.
>
> I don't know. Should these values be documented or not?
Of course.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#10346: 24.0.92; doc string of `save-buffer'
2014-02-09 5:35 ` Lars Ingebrigtsen
2014-02-11 15:02 ` Drew Adams
@ 2016-04-28 11:58 ` Lars Ingebrigtsen
2016-04-28 14:13 ` Drew Adams
1 sibling, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2016-04-28 11:58 UTC (permalink / raw)
To: Drew Adams; +Cc: 10346
Lars Ingebrigtsen <larsi@gnus.org> writes:
>> The doc string talks about the prefix arg, but no connection is made to
>> ARGS for use in Lisp.
>
> Yes. But the values for ARG are so... non-Lispey, I have a feeling
> that it's been left off by choice. The values are basically 0, 4, 16
> and 64, which are ... kinda opaque when calling a function like that.
>
> I don't know. Should these values be documented or not?
I think they're left out on purpose. Closing.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#10346: 24.0.92; doc string of `save-buffer'
2016-04-28 11:58 ` Lars Ingebrigtsen
@ 2016-04-28 14:13 ` Drew Adams
0 siblings, 0 replies; 6+ messages in thread
From: Drew Adams @ 2016-04-28 14:13 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: 10346
> Lars Ingebrigtsen <larsi@gnus.org> writes:
>
> >> The doc string talks about the prefix arg, but no connection is made to
> >> ARGS for use in Lisp.
> >
> > Yes. But the values for ARG are so... non-Lispey, I have a feeling
> > that it's been left off by choice. The values are basically 0, 4, 16
> > and 64, which are ... kinda opaque when calling a function like that.
> >
> > I don't know. Should these values be documented or not?
>
> I think they're left out on purpose. Closing.
Do you realize that you answered your own question?
This is a command. Interactively, ARG is the numeric prefix
arg. This should be stated in the doc string: What ARG is for
and how it is used.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2016-04-28 14:13 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-12-21 22:15 bug#10346: 24.0.92; doc string of `save-buffer' Drew Adams
2012-09-17 0:19 ` Drew Adams
2014-02-09 5:35 ` Lars Ingebrigtsen
2014-02-11 15:02 ` Drew Adams
2016-04-28 11:58 ` Lars Ingebrigtsen
2016-04-28 14:13 ` Drew Adams
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).