From: Eli Zaretskii <eliz@gnu.org>
To: Reuben Thomas <rrt@sc3d.org>
Cc: 49245@debbugs.gnu.org
Subject: bug#49245: Enchant dictionaries list not being correctly set, and other minor fixes
Date: Mon, 28 Jun 2021 17:37:01 +0300 [thread overview]
Message-ID: <837dieoy2a.fsf@gnu.org> (raw)
In-Reply-To: <CAOnWdogiVRm3HOnSPQy2zG=eM-E1q+vwyg4YUS+oTceft8+A2w@mail.gmail.com> (message from Reuben Thomas on Mon, 28 Jun 2021 13:31:01 +0100)
> From: Reuben Thomas <rrt@sc3d.org>
> Date: Mon, 28 Jun 2021 13:31:01 +0100
> Cc: 49245@debbugs.gnu.org
>
> but please don't remove that comment, it
> explains something important, and there's no reason to remove it (or
> many other similar comments we have throughout our code).
>
> In that case, please can you explain it, and I can rewrite it so that its significance is more evident. As I said, it
> explains why something was changed in the past (which is useful information in a commit message) rather
> than how or why the current code does something that may not be obvious just from reading the code
> (which would be suitable for a comment). Commit f0a1f8bdb5, which introduces it, has the message "Do
> not ignore short words". The current code does not have to *do* anything to check short words; that commit
> simply removed a check. I do not see anything in the current code that raises any questions that need
> answering by a comment. On the contrary, the comment raises a question: "is there some setting for
> minimum word length that I need to be aware of?". So I feel I've missed something here that a rewording of
> the comment could fix.
It is customary to leave a comment when we delete some code, but are
not 100% sure that code was a clear mistake. Since deleting code
leaves nothing behind (unlike if you add or change code), the comment
serves as a kind of "trace" for what once was there, but is no more.
If you want a practical case where this could be useful, imagine a bug
report regarding special treatment of words shorter than 3 letters
(which are normally ignored).
next prev parent reply other threads:[~2021-06-28 14:37 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-27 21:20 bug#49245: Enchant dictionaries list not being correctly set, and other minor fixes Reuben Thomas via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-06-28 12:13 ` Eli Zaretskii
2021-06-28 12:31 ` Reuben Thomas via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-06-28 14:37 ` Eli Zaretskii [this message]
2021-06-28 17:11 ` Reuben Thomas via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-06-28 17:12 ` bug#49245: Closing Reuben Thomas via Bug reports for GNU Emacs, the Swiss army knife of text editors
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=837dieoy2a.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=49245@debbugs.gnu.org \
--cc=rrt@sc3d.org \
/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).