GNU bug report logs - #47128
28.0.50; Be more helpful regarding message-syntax-checks

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 47128 in the body.
You can then email your comments to 47128 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Eric Abrahamsen <eric <at> ericabrahamsen.net>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.0.50; Be more helpful regarding message-syntax-checks
Date: Sat, 13 Mar 2021 14:38:56 -0800

[Message part 1 (text/plain, inline)]

The `message-syntax-checks' option doesn't have a very useful
customization :type, and the manual section explaining what it does
isn't in the most obvious spot. This patch moves the manual explanation
from "News Headers" to the more general "Message Headers" section, as
the option governs both mail and news. It also expands the :type
definition to explicitly list all the possible options.

The defcustom originally had two comments on it, one saying "Guess this
one shouldn't be easy to customize...", and another on the :type line
saying "improve this". That seems a bit contradictory.

Anyway, I don't see the point of actually obfuscating the use of this
option; this patch should make it a little more discoverable.

What would be even better is to obsolete this in favor of a new
`message-disabled-syntax-checks' option that was simply a plain list of
symbols.

Eric

[0001-Improvements-to-message-syntax-checks-docs-and-optio.patch (text/x-patch, attachment)]

Message #10 received at 47128 <at> debbugs.gnu.org (full text, mbox):

From: Eric Abrahamsen <eric <at> ericabrahamsen.net>
To: 47128 <at> debbugs.gnu.org
Subject: Re: bug#47128: 28.0.50; Be more helpful regarding
 message-syntax-checks
Date: Mon, 12 Apr 2021 09:46:19 -0700

Eric Abrahamsen <eric <at> ericabrahamsen.net> writes:

> The `message-syntax-checks' option doesn't have a very useful
> customization :type, and the manual section explaining what it does
> isn't in the most obvious spot. This patch moves the manual explanation
> from "News Headers" to the more general "Message Headers" section, as
> the option governs both mail and news. It also expands the :type
> definition to explicitly list all the possible options.
>
> The defcustom originally had two comments on it, one saying "Guess this
> one shouldn't be easy to customize...", and another on the :type line
> saying "improve this". That seems a bit contradictory.
>
> Anyway, I don't see the point of actually obfuscating the use of this
> option; this patch should make it a little more discoverable.
>
> What would be even better is to obsolete this in favor of a new
> `message-disabled-syntax-checks' option that was simply a plain list of
> symbols.

I feel like this is fairly uncontroversial -- does anyone have any
objections? I may just go ahead and push, otherwise. (I've since tweaked
the patch so that `message-syntax-checks' belongs to the
'message-headers group, in line with the other changes.)

Message #13 received at 47128 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eric Abrahamsen <eric <at> ericabrahamsen.net>
Cc: 47128 <at> debbugs.gnu.org
Subject: Re: bug#47128: 28.0.50; Be more helpful regarding
 message-syntax-checks
Date: Tue, 13 Apr 2021 09:47:11 +0200

Eric Abrahamsen <eric <at> ericabrahamsen.net> writes:

>> What would be even better is to obsolete this in favor of a new
>> `message-disabled-syntax-checks' option that was simply a plain list of
>> symbols.
>
> I feel like this is fairly uncontroversial -- does anyone have any
> objections? I may just go ahead and push, otherwise. (I've since tweaked
> the patch so that `message-syntax-checks' belongs to the
> 'message-headers group, in line with the other changes.)

The patch looks fine to me -- obsoleting the variable in favour of an
opposite variable doesn't seem to be optimal, though.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #18 received at 47128-done <at> debbugs.gnu.org (full text, mbox):

From: Eric Abrahamsen <eric <at> ericabrahamsen.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 47128-done <at> debbugs.gnu.org
Subject: Re: bug#47128: 28.0.50; Be more helpful regarding
 message-syntax-checks
Date: Tue, 13 Apr 2021 08:46:35 -0700

On 04/13/21 09:47 AM, Lars Ingebrigtsen wrote:
> Eric Abrahamsen <eric <at> ericabrahamsen.net> writes:
>
>>> What would be even better is to obsolete this in favor of a new
>>> `message-disabled-syntax-checks' option that was simply a plain list of
>>> symbols.
>>
>> I feel like this is fairly uncontroversial -- does anyone have any
>> objections? I may just go ahead and push, otherwise. (I've since tweaked
>> the patch so that `message-syntax-checks' belongs to the
>> 'message-headers group, in line with the other changes.)
>
> The patch looks fine to me -- obsoleting the variable in favour of an
> opposite variable doesn't seem to be optimal, though.

That's fine, it wasn't a big deal -- it just seemed oddly verbose to
require the 'disabled symbol, when 'disabled the only viable option. But
no actual harm in it, of course.

Closing this now...

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.