unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#45715: 27.1; Doc string of `dotimes'
@ 2021-01-07 15:08 Drew Adams
  2021-01-10 14:13 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 3+ messages in thread
From: Drew Adams @ 2021-01-07 15:08 UTC (permalink / raw)
  To: 45715

  Loop a certain number of times.
  Evaluate BODY with VAR bound to successive integers running from 0,
  inclusive, to COUNT, exclusive.  Then evaluate RESULT to get the
  return value (nil if RESULT is omitted).  Its use is deprecated.
                                            ^^^

In the last sentence, "its" is unclear.  Also, that sentence is missing
from the doc string of `cl-dotimes', even though it is present in the CL
Info manual.  And for `cl-dotimes' it should be made clear that this
"deprecation" is only about the Emacs Lisp emulation; the RETURN arg for
Common Lisp `dotimes' has not been deprecated.


In GNU Emacs 27.1 (build 1, x86_64-w64-mingw32)
 of 2020-08-12
Repository revision: 86d8d76aa36037184db0b2897c434cdaab1a9ae8
Windowing system distributor `Microsoft Corp.', version 10.0.18362
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static''





^ permalink raw reply	[flat|nested] 3+ messages in thread

* bug#45715: 27.1; Doc string of `dotimes'
  2021-01-07 15:08 bug#45715: 27.1; Doc string of `dotimes' Drew Adams
@ 2021-01-10 14:13 ` Lars Ingebrigtsen
  2021-01-11 13:16   ` Noam Postavsky
  0 siblings, 1 reply; 3+ messages in thread
From: Lars Ingebrigtsen @ 2021-01-10 14:13 UTC (permalink / raw)
  To: Drew Adams; +Cc: 45715

Drew Adams <drew.adams@oracle.com> writes:

>   Loop a certain number of times.
>   Evaluate BODY with VAR bound to successive integers running from 0,
>   inclusive, to COUNT, exclusive.  Then evaluate RESULT to get the
>   return value (nil if RESULT is omitted).  Its use is deprecated.
>                                             ^^^
>
> In the last sentence, "its" is unclear.

Indeed, which is why it's

---
Finally RESULT is evaluated to get the return value (nil if
RESULT is omitted).  Using RESULT is deprecated, and may result
in compilation warnings about unused variables.
---

in Emacs 28.

> Also, that sentence is missing from the doc string of `cl-dotimes',
> even though it is present in the CL Info manual.  And for `cl-dotimes'
> it should be made clear that this "deprecation" is only about the
> Emacs Lisp emulation; the RETURN arg for Common Lisp `dotimes' has not
> been deprecated.

The two are different functions, so I don't see why.  Closing.

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





^ permalink raw reply	[flat|nested] 3+ messages in thread

* bug#45715: 27.1; Doc string of `dotimes'
  2021-01-10 14:13 ` Lars Ingebrigtsen
@ 2021-01-11 13:16   ` Noam Postavsky
  0 siblings, 0 replies; 3+ messages in thread
From: Noam Postavsky @ 2021-01-11 13:16 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 45715

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Drew Adams <drew.adams@oracle.com> writes:
>
>>   Loop a certain number of times.
>>   Evaluate BODY with VAR bound to successive integers running from 0,
>>   inclusive, to COUNT, exclusive.  Then evaluate RESULT to get the
>>   return value (nil if RESULT is omitted).  Its use is deprecated.
>>                                             ^^^
>>
>> In the last sentence, "its" is unclear.
>
> Indeed, which is why it's
>
> ---
> Finally RESULT is evaluated to get the return value (nil if
> RESULT is omitted).  Using RESULT is deprecated, and may result
> in compilation warnings about unused variables.
> ---
>
> in Emacs 28.

Also, I've backported that change to emacs-27, so it will show up in
27.2.

[1: 9d02e6c5ff]: 2020-11-18 15:45:48 -0500
  Further doc fixes for dotimes about RESULT
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=9d02e6c5ff2a8af78ca8a2c934970f8a46dcef55





^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-01-11 13:16 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-07 15:08 bug#45715: 27.1; Doc string of `dotimes' Drew Adams
2021-01-10 14:13 ` Lars Ingebrigtsen
2021-01-11 13:16   ` Noam Postavsky

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).