From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#67355: [PATCH] Add doc string to simple.el Date: Wed, 22 Nov 2023 22:23:37 +0000 Message-ID: <87msv5e89n.fsf@jeremybryant.net> References: <87r0kiel47.fsf@jeremybryant.net> <83o7flhnem.fsf@gnu.org> Reply-To: Jeremy Bryant Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39180"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 67355@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Nov 22 23:25:14 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 1r5vej-0009z2-6q for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 22 Nov 2023 23:25:13 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r5veW-00047R-QB; Wed, 22 Nov 2023 17:25:00 -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 1r5veU-000474-Vr for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2023 17:24:59 -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 1r5veU-0008Vx-No for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2023 17:24:58 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r5veX-0000k8-Qm for bug-gnu-emacs@gnu.org; Wed, 22 Nov 2023 17:25:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 22 Nov 2023 22:25: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.17006918882832 (code B ref 67355); Wed, 22 Nov 2023 22:25:01 +0000 Original-Received: (at 67355) by debbugs.gnu.org; 22 Nov 2023 22:24:48 +0000 Original-Received: from localhost ([127.0.0.1]:60015 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r5veJ-0000jb-OM for submit@debbugs.gnu.org; Wed, 22 Nov 2023 17:24:48 -0500 Original-Received: from out-170.mta1.migadu.com ([2001:41d0:203:375::aa]:28859) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r5veG-0000jR-Dl for 67355@debbugs.gnu.org; Wed, 22 Nov 2023 17:24:45 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1700691879; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=nB5GTkM90hOAGhFxkzNh/EUUk5bkj1+LBgm5gixvNok=; b=kiEfUlTfdAs46BHdL/ubKccoiSyIpNVMXF4yJ2LL/8R60QLl5k11rvnCgQClIsnLY0sDpL IegS+o6E3FBvz1Um2ONRX/iIIOGGtNhI3SoZq/6M+wEespWFHHNBFppcrXiHZtBVaSeewn KB0mePdXkRuDy/aLrYrdbNl3okTnUpK4eQJbjHFGSwa6NXkTebEkyjylB9s6FGmNm/HmYA FU8L0lp8It+205/3Em0GplIm4L9uhtJA0Ec5R2Ikygm8siVZaqArH/21alUAe3PrFDyquD sDAHL318pTkjLSh9/IbMeu+irlT+nBcsI/fPZ8CpP0vwOKqyo6tcpcEHgLs9GA== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <83o7flhnem.fsf@gnu.org> X-Migadu-Flow: FLOW_OUT 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:274782 Archived-At: --=-=-= Content-Type: text/plain > >> (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. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-doc-string-to-simple.el.patch >From 66175becbcd074333b1cd72e033b54a2c3ca061c Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Tue, 21 Nov 2023 23:27:44 +0000 Subject: [PATCH] Add doc string to simple.el * lisp/simple.el (kill-buffer--possibly-save): Add doc string. --- lisp/simple.el | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lisp/simple.el b/lisp/simple.el index b770d9d7d33..9ef348f74dc 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -10863,6 +10863,10 @@ scratch-buffer (pop-to-buffer-same-window (get-scratch-buffer-create))) (defun kill-buffer--possibly-save (buffer) + "Ask the user to confirm killing of a modified BUFFER. + +If the user confirms, optionally save BUFFER that is about to be +killed." (let ((response (cadr (read-multiple-choice -- 2.40.1 --=-=-=--