From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Ted Zlatanov Newsgroups: gmane.emacs.devel Subject: should docstrings include all defcustom options? (was: netrc field encryption in auth-source) Date: Thu, 16 Jun 2011 20:03:12 -0500 Organization: =?utf-8?B?0KLQtdC+0LTQvtGAINCX0LvQsNGC0LDQvdC+0LI=?= @ Cienfuegos Message-ID: <87pqmd46cv.fsf_-_@lifelogs.com> References: <874o5cfui5.fsf@lifelogs.com> <87liyndz5l.fsf@lifelogs.com> <8739jogwf9.fsf@lifelogs.com> <87lix9eknu.fsf_-_@lifelogs.com> <878vt52ykv.fsf@lifelogs.com> <878vt25tbf.fsf@lifelogs.com> <87boxxx5k4.fsf@lifelogs.com> <87oc1xed2l.fsf@marauder.physik.uni-ulm.de> Reply-To: emacs-devel@gnu.org NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1308272635 18865 80.91.229.12 (17 Jun 2011 01:03:55 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 17 Jun 2011 01:03:55 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Jun 17 03:03:49 2011 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QXNTR-0005VY-8o for ged-emacs-devel@m.gmane.org; Fri, 17 Jun 2011 03:03:49 +0200 Original-Received: from localhost ([::1]:53087 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QXNTQ-0002Jl-BD for ged-emacs-devel@m.gmane.org; Thu, 16 Jun 2011 21:03:48 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:56612) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QXNT9-0002Ja-KH for emacs-devel@gnu.org; Thu, 16 Jun 2011 21:03:35 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QXNT5-0006x6-90 for emacs-devel@gnu.org; Thu, 16 Jun 2011 21:03:31 -0400 Original-Received: from lo.gmane.org ([80.91.229.12]:48016) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QXNT5-0006wx-0B for emacs-devel@gnu.org; Thu, 16 Jun 2011 21:03:27 -0400 Original-Received: from list by lo.gmane.org with local (Exim 4.69) (envelope-from ) id 1QXNT3-0005OB-Dl for emacs-devel@gnu.org; Fri, 17 Jun 2011 03:03:25 +0200 Original-Received: from c-67-186-102-106.hsd1.il.comcast.net ([67.186.102.106]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 17 Jun 2011 03:03:25 +0200 Original-Received: from tzz by c-67-186-102-106.hsd1.il.comcast.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 17 Jun 2011 03:03:25 +0200 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: emacs-devel@gnu.org Original-Lines: 32 Original-X-Complaints-To: usenet@dough.gmane.org X-Gmane-NNTP-Posting-Host: c-67-186-102-106.hsd1.il.comcast.net X-Face: bd.DQ~'29fIs`T_%O%C\g%6jW)yi[zuz6; d4V0`@y-~$#3P_Ng{@m+e4o<4P'#(_GJQ%TT= D}[Ep*b!\e,fBZ'j_+#"Ps?s2!4H2-Y"sx" Mail-Copies-To: never User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) Cancel-Lock: sha1:i2ALsTO6+/HICJ3digL5tM5FChg= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 80.91.229.12 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:140576 Archived-At: On Thu, 16 Jun 2011 22:28:02 +0200 Reiner Steib 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 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