Re: [PATCH 04/11] tempfile: fix documentation on `delete_tempfile()`
- Date: Mon, 2 Oct 2017 01:38:21 -0400
- From: Jeff King <peff@xxxxxxxx>
- Subject: Re: [PATCH 04/11] tempfile: fix documentation on `delete_tempfile()`
On Sun, Oct 01, 2017 at 04:56:05PM +0200, Martin Ågren wrote:
> The function has always been documented as returning 0 or -1. It is in
> fact `void`. Correct that. As part of the rearrangements we lose the
> mention that `delete_tempfile()` might set `errno`. Because there is
> no return value, the user can't really know whether it did anyway.
Right, your documentation change makes sense. Thanks for catching this.
I was curious if this inconsistency was introduced during review, but
even the initial version to the list returns void. So I guess it
happened sometime during the writing. :)