bug#67355: [PATCH] Add doc string to simple.el

[Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>]

[-- Attachment #1: Type: text/plain, Size: 177 bytes --]

Tags: patch


This patch adds a doc string to simple.el where there was none.

Please confirm if this is good to install or if any refinements are
needed.  Thanks in advance.



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-doc-string-to-simple.el.patch --]
[-- Type: text/patch, Size: 791 bytes --]

From 2ca9dab72f2aacb51e0b3d6d6403c4659e168fb9 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
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 | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/simple.el b/lisp/simple.el
index b770d9d7d33..69d29bc306b 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -10863,6 +10863,9 @@ scratch-buffer
   (pop-to-buffer-same-window (get-scratch-buffer-create)))
 
 (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."
   (let ((response
          (cadr
           (read-multiple-choice
-- 
2.40.1