Re: [PATCH 04/11] tempfile: fix documentation on `delete_tempfile()`
- From
Jeff King <peff@peff.net>
- Date
- Oct 2, 2017, 05:38 UTC
- Message-ID
- <20171002053821.itkkmi2png3m6gdw@sigill.intra.peff.net>
- In-Reply-To
- <17640b932b49cf86d53a0149300f65f01bff9135.1506862824.git.martin.agren@gmail.com>
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. :)
-Peff