unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Po Lu <luangruo@yahoo.com>
To: Visuwesh <visuweshm@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: master 11f44ec6dda: Enable DND handlers to receive more than one URI at a time
Date: Thu, 26 Oct 2023 21:44:14 +0800	[thread overview]
Message-ID: <87edhhzefl.fsf@yahoo.com> (raw)
In-Reply-To: <87jzr94jem.fsf@gmail.com> (Visuwesh's message of "Thu, 26 Oct 2023 18:42:33 +0530")

Visuwesh <visuweshm@gmail.com> writes:

> I find the new text is quite hard to understand, how about saying
>
>     Each handler function is called with the URL that matched it and one
                                                        -------

When was this matched?  You have excluded the text that indicates the
event where this comparison takes place.

>     of the symbols @code{copy}, @code{move}, @code{link}, @code{private}
>     or @code{ask} identifying the action to be taken.
>
>     @cindex dnd-multiple-handler, a symbol property
>     If the handler function is a symbol whose property
>     @code{dnd-multiple-handler} is non-@code{nil} (@pxref{Symbol
>     Properties}), then it is given a list of every URL that matches its
>     regexp as the first argument instead.

I want to place emphasis on the new behavior, so it must come first in
that paragraph.  But if there's anything else which you find ambiguous,
please say so.

I've come to recognize that documentation should generally avoid words
or collocations that betray indecision or uncertainty on the part of the
writer (consider "by default" or "instead").  The replacement for "by
default" is to mention the general behavior first, followed by an
account of each exception to it.  Words such as "instead" should be
removed, since they are inserted to clarify the subject of a
qualification, and become redundant once such qualifications are
directly placed after their subjects.  The documentation produced is
pither and less prey to interpretation.



  reply	other threads:[~2023-10-26 13:44 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <169832033169.28109.14749982523827239030@vcs2.savannah.gnu.org>
     [not found] ` <20231026113852.37241C09BEB@vcs2.savannah.gnu.org>
2023-10-26 13:12   ` master 11f44ec6dda: Enable DND handlers to receive more than one URI at a time Visuwesh
2023-10-26 13:44     ` Po Lu [this message]
2023-10-26 14:45       ` Visuwesh
2023-10-27  1:01         ` Po Lu
2023-10-28 11:20           ` Visuwesh
2023-10-28 11:37           ` Andreas Schwab
2023-10-28 11:49             ` Mattias Engdegård

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=87edhhzefl.fsf@yahoo.com \
    --to=luangruo@yahoo.com \
    --cc=emacs-devel@gnu.org \
    --cc=visuweshm@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).