GNU bug report logs - #52018
28.0.60; Improve documentation for compilation-finish-functions

Previous Next

Full log

View this message in rfc822 format

From: Thibault Polge <thibault <at> thb.lt>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52018 <at> debbugs.gnu.org
Subject: bug#52018: 28.0.60; Improve documentation for compilation-finish-functions
Date: Sun, 21 Nov 2021 20:44:46 +0100

> Maybe so, but I'm looking at the calls of compilation-handle-exit, and
> the callers do all kinds of transformations with the original status,
> so I think documenting what happens to be more-or-less correct now is
> fragile.

I assumed this interface was reasonably stable, I may be wrong.

> Why do you think this addition is of such great importance to have it
> spelled out in the doc string?

All the docstring currently states about that argument is that it's “a
string describing how the process finished”, which requires users to
determine its possible values through trial and error, or by digging
into the code.  I assumed it would be nicer (but not of “great
importance”) to just document it a bit further.

Best regards,

Previous Next

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