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: [PATCH] Add doc string to simple.el Date: Wed, 22 Nov 2023 16:29:21 +0200 Message-ID: <83o7flhnem.fsf@gnu.org> References: <87r0kiel47.fsf@jeremybryant.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="26149"; 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 Wed Nov 22 15:30:21 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 1r5oFA-0006ce-50 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 22 Nov 2023 15:30:20 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r5oEv-00086Q-TT; Wed, 22 Nov 2023 09:30:05 -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 1r5oEp-00085P-J0 for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2023 09:30:00 -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 1r5oEp-0004OE-9Y for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2023 09:29:59 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r5oEs-00041C-Gr for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2023 09:30:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 22 Nov 2023 14:30:02 +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.170066338415401 (code B ref 67355); Wed, 22 Nov 2023 14:30:02 +0000 Original-Received: (at 67355) by debbugs.gnu.org; 22 Nov 2023 14:29:44 +0000 Original-Received: from localhost ([127.0.0.1]:58472 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r5oEZ-00040K-I1 for submit@debbugs.gnu.org; Wed, 22 Nov 2023 09:29:43 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53766) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r5oEY-0003zs-7i for 67355@debbugs.gnu.org; Wed, 22 Nov 2023 09:29:42 -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 1r5oEN-0004K5-Az; Wed, 22 Nov 2023 09:29:32 -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=/vCweKNqQ0pG9epCTZY8GKqWxbJVRAIgKWhlC50gnqI=; b=gGSChmF5zFYD jsU1V3maM8FAePKUKrrQ87xQaXyVRhQrnfpDqMAd9jmzShfnI3xwC6R0ke03Y0k7GwkqkMgYEvGTH qVrdRna66Ju/sU2uYc++RsW3nGnI/N3WAkpJFlgOFYo1RYLm0Yly7zxw0hcyyCC06xloJj54GzQ6D 1lsl1jPhWcGvVunjEgOWmjU5twsgMbBmVmXPhbBOSDAvc14PHTTTnF5ILl9PeciOnllArZscT41G4 +R1yBT0q0/q/8w3MEwSwm9LelpsbezCIjXyn11bl4vHcQfpKFXP2CoTKPbeW9gnMwif6DgOA/PNBp chqptF9on7b5Y9R55CNQLw==; In-Reply-To: <87r0kiel47.fsf@jeremybryant.net> (bug-gnu-emacs@gnu.org) 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:274756 Archived-At: > Date: Tue, 21 Nov 2023 23:33:50 +0000 > From: Jeremy Bryant via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > This patch adds a doc string to simple.el where there was none. Thanks. > Please confirm if this is good to install or if any refinements are > needed. Thanks in advance. Below. > (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.