unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Karl Fogel <kfogel@red-bean.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: larsi@gnus.org, orontee@gmail.com, monnier@iro.umontreal.ca,
	drew.adams@oracle.com, emacs-devel@gnu.org
Subject: Re: [External] : Re: [PATCH] When deleting in bookmark menu, prompt for confirmation.
Date: Tue, 25 May 2021 00:38:22 -0500	[thread overview]
Message-ID: <87wnrn4bld.fsf@red-bean.com> (raw)
In-Reply-To: <83cztz7nvd.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 09 May 2021 21:39:34 +0300")

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

On 09 May 2021, Eli Zaretskii wrote:
>> From: Karl Fogel <kfogel@red-bean.com>
>> Cc: Matthias Meulien <orontee@gmail.com>, 
>> drew.adams@oracle.com,
>>   larsi@gnus.org,  monnier@iro.umontreal.ca, 
>>   emacs-devel@gnu.org
>> Date: Sun, 09 May 2021 13:37:52 -0500
>> 
>> My inclination would be to do this by having 
>> `bookmark-bmenu-load' 
>> just refer readers to `bookmark-load', and then improving the 
>> latter's doc string.  That way if future changes are made to 
>> `bookmark-load's behavior, we wouldn't need to remember to 
>> update 
>> `bookmark-bmenu-load's doc string too.
>> 
>> Thoughts?
>
>I'll have thoughts when I see the result ;-)

Heh, fair enough.  My inquiry was about the general practice of 
having one function's doc string referring out to another 
function's.  But it sounds like you have no objection to that, and 
neither do I.

If the attached doc patch looks sensible, I'll commit it.

Best regards,
-Karl


[-- Attachment #2: 0001-Improve-bookmark-bmenu-load-doc-string.patch --]
[-- Type: text/plain, Size: 1372 bytes --]

From e0dac0712bf2ee9cef1ab067dbc26c6a00a1f85b Mon Sep 17 00:00:00 2001
From: Karl Fogel <kfogel@red-bean.com>
Date: Tue, 25 May 2021 00:26:57 -0500
Subject: [PATCH] Improve `bookmark-bmenu-load' doc string

* lisp/bookmark.el (bookmark-bmenu-load): Refer reader to
  `bookmark-load' for more information.

As discussed in this thread:

  https://lists.gnu.org/archive/html/emacs-devel/2021-05/msg00389.html

  From: Karl Fogel
  To: Eli Zaretskii
  Cc: Matthias Meulien, Drew Adams, Lars Ingebrigtsen,
      Stefan Monnier, Emacs Devel
  Subject: Re: [External] : Re: [PATCH] When deleting in bookmark menu,
           prompt for confirmation.
  Date: Sun, 09 May 2021 13:37:52 -0500
  Message-ID: <87h7jboirj.fsf@red-bean.com>
---
 lisp/bookmark.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git lisp/bookmark.el lisp/bookmark.el
index 64b467adfa..e6a22f9bf0 100644
--- lisp/bookmark.el
+++ lisp/bookmark.el
@@ -2063,7 +2063,9 @@ bookmark-bmenu-save
 
 
 (defun bookmark-bmenu-load ()
-  "Load the bookmark file and rebuild the bookmark menu-buffer."
+  "Load the bookmark file and rebuild the bookmark menu-buffer.
+This invokes `bookmark-load' interactively, so see there for more
+information (such as how a prefix argument is handled)."
   (interactive nil bookmark-bmenu-mode)
   (bookmark-bmenu-ensure-position)
   (save-excursion
-- 
2.30.2


  reply	other threads:[~2021-05-25  5:38 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-03  3:43 [PATCH] When deleting in bookmark menu, prompt for confirmation Karl Fogel
2021-05-03  9:16 ` Lars Ingebrigtsen
2021-05-03 12:48   ` Stefan Kangas
2021-05-03 13:02     ` Stefan Monnier
2021-05-04  7:53     ` Lars Ingebrigtsen
2021-05-04 16:29       ` [External] : " Drew Adams
2021-05-03 11:41 ` Eli Zaretskii
2021-05-03 12:47   ` Stefan Kangas
2021-05-03 13:16     ` Eli Zaretskii
2021-05-03 15:43       ` Stefan Kangas
2021-05-03 16:25         ` Eli Zaretskii
2021-05-03 17:21         ` Karl Fogel
2021-05-03 17:41           ` Eli Zaretskii
2021-05-03 18:28             ` Jim Porter
2021-05-03 18:44               ` Eli Zaretskii
2021-05-03 19:01                 ` Jim Porter
2021-05-03 20:52             ` Karl Fogel
2021-05-05  5:24             ` Karl Fogel
2021-05-05  8:11               ` Lars Ingebrigtsen
2021-05-05 19:37                 ` Karl Fogel
2021-05-05 20:06                   ` Stefan Monnier
2021-05-05 21:38                     ` Karl Fogel
2021-05-05 23:17                       ` [External] : " Drew Adams
2021-05-05 23:25                         ` Karl Fogel
2021-05-06  6:52                         ` Matthias Meulien
2021-05-06 15:29                           ` Drew Adams
2021-05-08 20:46                             ` Matthias Meulien
2021-05-09  8:54                               ` Eli Zaretskii
2021-05-09 18:37                                 ` Karl Fogel
2021-05-09 18:39                                   ` Eli Zaretskii
2021-05-25  5:38                                     ` Karl Fogel [this message]
2021-05-25 12:09                                       ` Eli Zaretskii
2021-05-25 20:24                                         ` Karl Fogel
2021-05-26 11:59                                           ` Eli Zaretskii
2021-05-26 19:33                                             ` Karl Fogel
2021-05-07 17:42                           ` Karl Fogel
2021-05-07 22:24                             ` Drew Adams
2021-05-08  6:13                               ` Karl Fogel
2021-05-06  8:49                   ` Lars Ingebrigtsen
2021-05-06 13:30                     ` Stefan Monnier
2021-05-07  8:40                       ` Lars Ingebrigtsen
2021-05-07 12:55                         ` Stefan Monnier
2021-05-09  9:55                           ` Lars Ingebrigtsen
2021-05-09 15:04                             ` Stefan Kangas
2021-05-09 18:01                               ` Stefan Monnier
2021-05-10  8:30                               ` Lars Ingebrigtsen
2021-05-07 17:40                     ` Karl Fogel
2021-05-05 11:56               ` Eli Zaretskii
2021-05-05 21:43                 ` Karl Fogel
2021-05-03 17:43           ` [External] : " Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87wnrn4bld.fsf@red-bean.com \
    --to=kfogel@red-bean.com \
    --cc=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=larsi@gnus.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=orontee@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).