unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Howard Melman <hmelman@gmail.com>
Cc: 55527@debbugs.gnu.org
Subject: bug#55527: 28.1; Clearer abbrev docstrings
Date: Fri, 20 May 2022 08:48:28 +0300	[thread overview]
Message-ID: <837d6gdaab.fsf@gnu.org> (raw)
In-Reply-To: <lyczg9jm0d.fsf@new-host-2.home> (message from Howard Melman on Thu, 19 May 2022 16:38:42 -0400)

> From: Howard Melman <hmelman@gmail.com>
> Date: Thu, 19 May 2022 16:38:42 -0400
> 
> > If you add the expansion part, the line becomes too long, though:
> >
> >   Define last word before point as expansion of a global (mode-independent) abbrev.
> 
> I think you can loose the "mode-independent" part, as global
> covers that pretty clearly, how about:
> 
>    Define last word before point as expansion of a global abbrev.

No, "global" doesn't explain itself in this case, because we aren't
talking about a minor mode.  So I'd rather lose "a" or even replace
"of a" with "for".  We could also lose "last".

> > It will be called, but by whom and when?
> 
> Yes that was *my* point.  The original says:
> 
> Define an abbrev in TABLE named NAME, to expand to EXPANSION and call HOOK.
> 
> which to me doesn't answer "by whom and when"

Yes, it does: the abbrev you define will call HOOK at the time of the
expansion.  That's what the sentence says.

>   Define in TABLE an ABBREV and its EXPANSION and optionally its HOOK.

"Define in TABLE" is awkward (or even incorrect) English.  OTOH,
"optionally" is redundant, so maybe if we lose it, we could reword the
sentence to be more correct English-wise.

> I don't think it's at all obvious how the original clauses
> relate to each other (thankfully the full docstring is much
> clearer) but as you brought up non-native english speakers I
> would think the original is also difficult for them.

The comparison is always relative, not absolute.  And if the full doc
string makes things clear, it's fine.





  reply	other threads:[~2022-05-20  5:48 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-19 18:32 bug#55527: 28.1; Clearer abbrev docstrings Howard Melman
2022-05-19 18:52 ` Eli Zaretskii
2022-05-19 19:30   ` Howard Melman
2022-05-19 19:46     ` Eli Zaretskii
2022-05-19 20:38       ` Howard Melman
2022-05-20  5:48         ` Eli Zaretskii [this message]
2022-05-20 13:35           ` Howard Melman
2022-05-20 15:59             ` Eli Zaretskii
2022-05-20 17:03               ` Howard Melman
2022-05-21  7:23                 ` Eli Zaretskii
2022-05-21 13:41                   ` Howard Melman
2022-05-21 14:09                     ` Eli Zaretskii
2022-05-21 17:49                       ` Howard Melman
2022-05-21 18:06                         ` Eli Zaretskii
2022-05-21 18:26                           ` Howard Melman
2022-05-21 18:46                             ` Eli Zaretskii
2022-05-20  7:41 ` Juri Linkov
2022-05-20 13:12   ` Howard Melman

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=837d6gdaab.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=55527@debbugs.gnu.org \
    --cc=hmelman@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).