all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Stefan Kangas <stefan@marxist.se>, 35916@debbugs.gnu.org
Subject: bug#35916: [PATCH] checkdoc fixes in bookmark.el
Date: Sun, 26 May 2019 20:52:42 -0700 (PDT)	[thread overview]
Message-ID: <3d7f02e2-c064-4da4-b6e0-e7b52d0d357d@default> (raw)
In-Reply-To: <CADwFkm=hx69HcKS4H8yAjnNtok8rHZFmow0RaJeRsL=6-dVu=A@mail.gmail.com>

(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	other threads:[~2019-05-27  3:52 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-26 10:59 bug#35916: [PATCH] checkdoc fixes in bookmark.el Stefan Kangas
2019-05-27  3:52 ` Drew Adams [this message]
2019-05-27 21:36   ` Stefan Kangas
2019-05-30 17:53     ` Stefan Kangas
2019-06-08  8:37       ` Eli Zaretskii
2019-06-08 17:22         ` Stefan Kangas
2019-06-09  6:51           ` Eli Zaretskii

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

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

  git send-email \
    --in-reply-to=3d7f02e2-c064-4da4-b6e0-e7b52d0d357d@default \
    --to=drew.adams@oracle.com \
    --cc=35916@debbugs.gnu.org \
    --cc=stefan@marxist.se \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.