[PATCH] Improve docstring for delete-active-region (was Re: [WIP PATCH] Adding more keybindings to rectangle-mark-mode-map)

[Jim Porter <jporterbugs@gmail.com>]

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

On Fri, May 7, 2021 at 11:55 PM Andreas Schwab <schwab@linux-m68k.org> wrote:
> Please describe the effect of the prefix in the doc string.

Good point. How does this look?

I've also attached a tiny patch to improve the docstring for the next
function in the file, `delete-selection-repeat-replace-region'. It was
using a literal "C-u", so I modified it to use
"\\[universal-argument]".

- Jim

[-- Attachment #2: 0002-Improve-docstring-for-delete-selection-repeat-replac.patch --]
[-- Type: application/octet-stream, Size: 1153 bytes --]

From 359166d632a113145ee71c4e18f03893f181aa76 Mon Sep 17 00:00:00 2001
From: Jim Porter <jporterbugs@gmail.com>
Date: Sat, 8 May 2021 11:53:27 -0700
Subject: [PATCH 2/2] Improve docstring for
 delete-selection-repeat-replace-region

* lisp/delsel.el (delete-selection-repeat-replace-region):
Use "\\[universal-argument]" instead of literal "C-u" in docstring.
---
 lisp/delsel.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/delsel.el b/lisp/delsel.el
index 75cc2b1c2e..3c99dd2344 100644
--- a/lisp/delsel.el
+++ b/lisp/delsel.el
@@ -108,7 +108,7 @@ delete-selection-repeat-replace-region
   "Repeat replacing text of highlighted region with typed text.
 Search for the next stretch of text identical to the region last replaced
 by typing text over it and replaces it with the same stretch of text.
-With ARG, repeat that many times.  `C-u' means until end of buffer."
+With ARG, repeat that many times.  `\\[universal-argument]' means until end of buffer."
   (interactive "P")
   (let ((old-text (and delete-selection-save-to-register
                        (get-register delete-selection-save-to-register)))
-- 
2.25.1


[-- Attachment #3: 0001-Improve-docstring-for-delete-active-region.patch --]
[-- Type: application/octet-stream, Size: 877 bytes --]

From ab1fc7b3e45a0645b313a7ab285bb926e7279012 Mon Sep 17 00:00:00 2001
From: Jim Porter <jporterbugs@gmail.com>
Date: Sat, 8 May 2021 11:53:16 -0700
Subject: [PATCH 1/2] Improve docstring for delete-active-region

* lisp/delsel.el (delete-active-region): Document interactive behavior.
---
 lisp/delsel.el | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lisp/delsel.el b/lisp/delsel.el
index 96a9dcc0c7..75cc2b1c2e 100644
--- a/lisp/delsel.el
+++ b/lisp/delsel.el
@@ -87,7 +87,8 @@ delsel--replace-text-or-position
 ;;;###autoload
 (defun delete-active-region (&optional killp)
   "Delete the active region.
-If KILLP in not-nil, the active region is killed instead of deleted."
+If KILLP is non-nil, or if called interactively with a prefix argument,
+the active region is killed instead of deleted."
   (interactive "P")
   (cond
    (killp
-- 
2.25.1