GNU bug report logs - #67355
[PATCH] Add doc string to simple.el

Previous Next

Full log

View this message in rfc822 format

From: Jeremy Bryant <jb <at> jeremybryant.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 67355 <at> debbugs.gnu.org
Subject: bug#67355: [PATCH] Add doc string to simple.el
Date: Wed, 22 Nov 2023 22:23:37 +0000

[Message part 1 (text/plain, inline)]

>
>>  (defun kill-buffer--possibly-save (buffer)
>> +  "Prompt user whether to kill BUFFER, possibly saving it first.
>> +
>> +This assumes the buffer is known to be modified."
>
> This prefers the description of what function does to describing its
> role.  I think it is better to do the opposite:
>
>     Ask the user to confirm killing of a modified BUFFER.
>
>   If the user confirms, optionally save BUFFER that is about to be
>   killed.

Style noted, revised patch attached.

[0001-Add-doc-string-to-simple.el.patch (text/x-diff, attachment)]

Previous Next

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