[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#49245: Enchant dictionaries list not being correctly set, and other
From: |
Eli Zaretskii |
Subject: |
bug#49245: Enchant dictionaries list not being correctly set, and other minor fixes |
Date: |
Mon, 28 Jun 2021 17:37:01 +0300 |
> 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).