GNU bug report logs - #36417
[PATCH] Document bookmark annotations in Emacs Manual

Previous Next

Full log

View this message in rfc822 format

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 36417 <at> debbugs.gnu.org
Subject: bug#36417: [PATCH] Document bookmark annotations in Emacs Manual
Date: Fri, 28 Jun 2019 17:13:33 +0200

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:
> > +@vindex bookmark-use-annotations
> > +@vindex bookmark-automatically-show-annotations
>
> How about "@cindex bookmark annotations" as well?

Done.

> > +  If you set the variable @code{bookmark-use-annotations} to t,
>                                                                 ^
> @code{t}

Done.  Would we also want to do this change while we're at it, or is
it ok as is?

-  If you set the variable @code{bookmark-save-flag} to 1, each command
+  If you set the variable @code{bookmark-save-flag} to @code{1}, each command

> > +setting a bookmark will query for an annotation.  The annotation will
> > +be automatically shown when you jump to that bookmark.
>
> Please explain what does "show" mean in this context.

Done.  Let me know if it's not clear enough.

> Btw, what is the use case for using annotations but not showing them?
> If that use case is not important enough, perhaps we shouldn't mention
> the second option.

Good point.  I don't think it's a very important use case, so I
removed it.

Thank you for reviewing; sorry about the basic mistakes.  Please find
attached an updated patch.

Thanks,
Stefan Kangas

[0001-Document-bookmark-annotations-in-Emacs-Manual.patch (text/x-patch, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.