unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Thibault Polge <thibault@thb.lt>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 52018@debbugs.gnu.org
Subject: bug#52018: 28.0.60; Improve documentation for compilation-finish-functions
Date: Sun, 21 Nov 2021 20:44:46 +0100	[thread overview]
Message-ID: <87sfvpguoh.fsf@thb.lt> (raw)
In-Reply-To: <83ilwlqpiw.fsf@gnu.org>

> 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,





  reply	other threads:[~2021-11-21 19:44 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-21 10:48 bug#52018: 28.0.60; Improve documentation for compilation-finish-functions Thibault Polge
2021-11-21 15:13 ` Eli Zaretskii
2021-11-21 19:08   ` Thibault Polge
2021-11-21 19:25     ` Eli Zaretskii
2021-11-21 19:44       ` Thibault Polge [this message]
2021-11-21 19:53         ` Eli Zaretskii
2021-11-21 20:00           ` Thibault Polge
2021-11-21 20:11             ` Eli Zaretskii
2021-11-21 20:20               ` Thibault Polge
2021-11-21 20:29                 ` Eli Zaretskii
2021-11-22  9:12                   ` Thibault Polge
2021-11-22 16:56                     ` Eli Zaretskii
2021-11-23  9:26                       ` Thibault Polge
2021-11-23 12:47                         ` Eli Zaretskii
2021-11-24  7:02                           ` Lars Ingebrigtsen
2021-11-24 12:40                             ` Eli Zaretskii
2021-11-24 16:31                               ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87sfvpguoh.fsf@thb.lt \
    --to=thibault@thb.lt \
    --cc=52018@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).