GNU bug report logs - #52337
27.2; Doc string of `dired-check-process'

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Mon, 6 Dec 2021 20:57:02 UTC

Severity: minor

Found in version 27.2

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#52337: closed (27.2; Doc string of `dired-check-process')
Date: Tue, 07 Dec 2021 17:49:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Tue, 07 Dec 2021 19:48:22 +0200
with message-id <83sfv4xq55.fsf <at> gnu.org>
and subject line Re: bug#52337: 27.2; Doc string of `dired-check-process'
has caused the debbugs.gnu.org bug report #52337,
regarding 27.2; Doc string of `dired-check-process'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
52337: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=52337
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Drew Adams <drew.adams <at> oracle.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: 27.2; Doc string of `dired-check-process'
Date: Mon, 6 Dec 2021 20:55:57 +0000

1. Please consider filling the third sentence ("On error,...").

2. The "Else returns nil for success." isn't too clear.  Please consider
making it more clear that the return value is nil for success and either
ARGUMENTS or PROGRAM for failure.

It's also not clear under what conditions, or when, ARGUMENTS is
returned or PROGRAM is returned.  "Offending" doesn't help in that
regard.  Is it possible for both ARGUMENTS and PROGRAM to "offend"?

In GNU Emacs 27.2 (build 1, x86_64-w64-mingw32)
 of 2021-03-26 built on CIRROCUMULUS
Repository revision: deef5efafb70f4b171265b896505b92b6eef24e6
Repository branch: HEAD
Windowing system distributor 'Microsoft Corp.', version 10.0.19042
System Description: Microsoft Windows 10 Pro (v10.0.2009.19042.1348)

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Type C-x 1 to delete the help window.

Configured using:
 'configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static''


[Message part 3 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 52337-done <at> debbugs.gnu.org
Subject: Re: bug#52337: 27.2; Doc string of `dired-check-process'
Date: Tue, 07 Dec 2021 19:48:22 +0200
> From: Drew Adams <drew.adams <at> oracle.com>
> Date: Mon, 6 Dec 2021 20:55:57 +0000
> 
> 1. Please consider filling the third sentence ("On error,...").
> 
> 2. The "Else returns nil for success." isn't too clear.  Please consider
> making it more clear that the return value is nil for success and either
> ARGUMENTS or PROGRAM for failure.
> 
> It's also not clear under what conditions, or when, ARGUMENTS is
> returned or PROGRAM is returned.  "Offending" doesn't help in that
> regard.  Is it possible for both ARGUMENTS and PROGRAM to "offend"?

Thanks, I fixed this on the emacs-28 branch.


This bug report was last modified 3 years and 167 days ago.

Previous Next


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