bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#35916: [PATCH] checkdoc fixes in bookmark.el


From: Drew Adams
Subject: bug#35916: [PATCH] checkdoc fixes in bookmark.el
Date: Sun, 26 May 2019 20:52:42 -0700 (PDT)

(Minor feedback.) 

1. This one is wrong, IMO:

- HANDLER is a function that provides the bookmark-jump behavior for a
+ HANDLER is a function that provides the `bookmark-jump' behavior for a

That use of "bookmark-jump" is just an adjective, not the name of the specific 
command `bookmark-jump'.

The point of the handler is to provide alternative behavior from what command 
`bookmark-jump' provides.  But in all cases that alternative is some kind of a 
"bookmark-jump behavior" - not behavior of command `bookmark-jump' but some 
bookmark-jumping behavior.

You could in fact alternatively say "bookmark-jumping behavior".  But there's 
no need to (and it's not about a bookmark jumping but about jumping to a 
bookmark location).

2. This one has a typo:

+If the annotation does not exists, do nothing."
                            ^
                            exist

3. This one makes some helpful corrections, but Emacs doesn't
call this a "file path".  It calls it an "absolute file name".

+  "Change the file path of the bookmark on the current line.
+Prompt with completion for the new path."


All the other changes look like improvements, to me.  Thx.

(And bug reports #35917 and #35918 are also welcome.)





reply via email to

[Prev in Thread] Current Thread [Next in Thread]