From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#67355: Maybe update manual - Re: bug#67355: [PATCH] Add doc string to simple.el Date: Thu, 23 Nov 2023 17:27:17 +0200 Message-ID: <83r0kgfq22.fsf@gnu.org> References: <87r0kiel47.fsf@jeremybryant.net> <83o7flhnem.fsf@gnu.org> <87fs0xe7mv.fsf@jeremybryant.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8335"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 67355@debbugs.gnu.org To: Jeremy Bryant Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Nov 23 16:28:17 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1r6Bcm-0001sT-FZ for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 23 Nov 2023 16:28:16 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r6BcZ-0003OI-L9; Thu, 23 Nov 2023 10:28:03 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r6BcU-0003Nv-KA for bug-gnu-emacs@gnu.org; Thu, 23 Nov 2023 10:27:58 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1r6BcU-0007EL-0C for bug-gnu-emacs@gnu.org; Thu, 23 Nov 2023 10:27:58 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r6BcX-0002fw-SZ for bug-gnu-emacs@gnu.org; Thu, 23 Nov 2023 10:28:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 23 Nov 2023 15:28:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 67355 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 67355-submit@debbugs.gnu.org id=B67355.170075325610254 (code B ref 67355); Thu, 23 Nov 2023 15:28:01 +0000 Original-Received: (at 67355) by debbugs.gnu.org; 23 Nov 2023 15:27:36 +0000 Original-Received: from localhost ([127.0.0.1]:34692 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r6Bc8-0002fJ-GR for submit@debbugs.gnu.org; Thu, 23 Nov 2023 10:27:36 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:40662) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r6Bc6-0002f6-Qt for 67355@debbugs.gnu.org; Thu, 23 Nov 2023 10:27:35 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r6Bbx-00079z-H8; Thu, 23 Nov 2023 10:27:25 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=z/Fs2yoacemDVB5XbPIyp4XCgfPq4m/fkRLtBqNnsLI=; b=amb+CjYtBl+p jaC4q1VRWryeQyh+uEclCJ+dqPh6ikonj5RnCHNV1yLt/PzlUoU9KgOu2E3VrgZLhB5BQ9+yG3XYY nu3L7fNucnRK/CpxRPut2YlUpxJ6HAGGX+VelYl9G+bh/WYH6C0QdLO2vNrVq6ecfGnYhJzxEDrYO GbhL/7ddmehgWEhjALhupZzNDQ15mhYV929BNT7ouMVhUxWmnDvu4Kn1UJCF5MmBZfFx9EHfVF0wJ kYHBWpOw3AA5jTWEu7ZtBdS0rbJNhlDPQI9x8OXEHFQeUjm2DwKUJu2eVQCaRZEiq66XCAICCzx2G C80BQ/ebHm0CiSlkhPg1Mw==; In-Reply-To: <87fs0xe7mv.fsf@jeremybryant.net> (message from Jeremy Bryant on Wed, 22 Nov 2023 22:33:17 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:274812 Archived-At: > From: Jeremy Bryant > Cc: 67355@debbugs.gnu.org > Date: Wed, 22 Nov 2023 22:33:17 +0000 > > > > >> (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. > > Is there any issue with a potential update to the manual at (elisp) > Documentation Tips, by adding a line to reflect this tip? Let me know > and I can prepare a separate patch. I added there something similar to your suggestion. Thanks.