[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
should docstrings include all defcustom options? (was: netrc field encry
From: |
Ted Zlatanov |
Subject: |
should docstrings include all defcustom options? (was: netrc field encryption in auth-source) |
Date: |
Thu, 16 Jun 2011 20:03:12 -0500 |
User-agent: |
Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) |
On Thu, 16 Jun 2011 22:28:02 +0200 Reiner Steib <address@hidden> wrote:
RS> On Thu, Jun 16 2011, Ted Zlatanov wrote:
>> You're just listing the defcustom choices in the docstring itself.
RS> The user should be able to figure out the valid values without jumping
RS> to the defcustom or using customize.
Is this recommended anywhere in the ELisp manual? First time I hear
about it; it's been years since I read the whole thing end to end so
apologies if I've missed or forgotten this recommendation.
>> What if we add choices? We have to edit the docstring again.
RS> Sure. So what? ;-)
It's twice the work. For me. And it's prone to errors, and it doesn't
convey additional information to the user.
On Thu, 16 Jun 2011 23:05:38 +0200 Lars Magne Ingebrigtsen <address@hidden>
wrote:
LMI> Perhaps `describe-variable' should list the customisation values and
LMI> meanings?
That would be smart. I'd actually inline the customization interface
right in there, instead of forcing the user to follow a link in order to
customize. Maybe as a tab or a collapsed dialog.
But all of that is besides the point of netrc field encryption... So
I've changed the thread subject accordingly.
Ted
- netrc field encryption in auth-source (was: Opportunistic STARTTLS in smtpmail.el), (continued)
- netrc field encryption in auth-source (was: Opportunistic STARTTLS in smtpmail.el), Ted Zlatanov, 2011/06/10
- Re: netrc field encryption in auth-source, Ted Zlatanov, 2011/06/13
- Re: netrc field encryption in auth-source, Lars Magne Ingebrigtsen, 2011/06/13
- Re: netrc field encryption in auth-source, Lars Magne Ingebrigtsen, 2011/06/15
- Re: netrc field encryption in auth-source, Lars Magne Ingebrigtsen, 2011/06/15
- Re: netrc field encryption in auth-source, Ted Zlatanov, 2011/06/15
- Re: netrc field encryption in auth-source, Robert Pluim, 2011/06/16
- Re: netrc field encryption in auth-source, Ted Zlatanov, 2011/06/16
- Re: netrc field encryption in auth-source, Reiner Steib, 2011/06/16
- Re: netrc field encryption in auth-source, Lars Magne Ingebrigtsen, 2011/06/16
- should docstrings include all defcustom options? (was: netrc field encryption in auth-source),
Ted Zlatanov <=
- Re: netrc field encryption in auth-source, Robert Pluim, 2011/06/17
- Re: netrc field encryption in auth-source, Ted Zlatanov, 2011/06/17
- Re: netrc field encryption in auth-source, Ted Zlatanov, 2011/06/17
- Re: netrc field encryption in auth-source, Robert Pluim, 2011/06/17
- Re: netrc field encryption in auth-source, Lars Magne Ingebrigtsen, 2011/06/21
- Re: netrc field encryption in auth-source, Ted Zlatanov, 2011/06/21
- Committing new smtpmail.el later tonight (was: netrc field encryption in auth-source), Lars Magne Ingebrigtsen, 2011/06/21
- Re: Committing new smtpmail.el later tonight, Lars Magne Ingebrigtsen, 2011/06/21
- Re: Committing new smtpmail.el later tonight, Antoine Levitt, 2011/06/21
- Re: Committing new smtpmail.el later tonight, Lars Magne Ingebrigtsen, 2011/06/21