[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#22019: 25.0.50; Bad comment in `character-fold-to-regexp'
|
From: |
Artur Malabarba |
|
Subject: |
bug#22019: 25.0.50; Bad comment in `character-fold-to-regexp' |
|
Date: |
Thu, 26 Nov 2015 23:40:01 +0000 |
On 26 Nov 2015 11:03 pm, "Drew Adams" <drew.adams@oracle.com> wrote:
>
> This part of an explanatory comment is inadequate and inappropriate:
>
> ;; See commit message for a longer description.
>
> What commit message? The source code should contain the description.
> If a VC commit message happens to also contain the description, so
> much the better for it. But that doesn't help a reader of the code.
Maybe I'm just a little too acostumed to the convenience of magit-blame. Commit messages are the first place I look when I don't understand the code. But I understand that doesn't help readers who are not reading directly from the repo, so a better comment would be nice.