From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id EuB7GFXvtV+4MAAA0tVLHw (envelope-from ) for ; Thu, 19 Nov 2020 04:06:45 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id IEvHE1XvtV8maAAA1q6Kng (envelope-from ) for ; Thu, 19 Nov 2020 04:06:45 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 978A594011C for ; Thu, 19 Nov 2020 04:06:44 +0000 (UTC) Received: from localhost ([::1]:44982 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kfbDX-0004I7-DI for larch@yhetil.org; Wed, 18 Nov 2020 23:06:43 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:43252) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kfbCe-0004Gz-U4 for emacs-orgmode@gnu.org; Wed, 18 Nov 2020 23:05:49 -0500 Received: from pb-smtp1.pobox.com ([64.147.108.70]:51092) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kfbCb-00029V-Af for emacs-orgmode@gnu.org; Wed, 18 Nov 2020 23:05:48 -0500 Received: from pb-smtp1.pobox.com (unknown [127.0.0.1]) by pb-smtp1.pobox.com (Postfix) with ESMTP id 1AF4BA3615; Wed, 18 Nov 2020 23:05:43 -0500 (EST) (envelope-from kyle@kyleam.com) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=pobox.com; h=from:to:cc :subject:in-reply-to:references:date:message-id:mime-version :content-type:content-transfer-encoding; s=sasl; bh=HFBDHtGYFjW6 94NdNJoUVDKeheU=; b=vtkzj1cskbFV6VsuAIodlIytYy+QmZ0LxTmiS4eg/uJ/ ZE01mZsEpxlOwPZwWJrX7/SfRygMMQb0EsCczP6rl+r9oqkTdLOL9wPFAn63rVb/ RQAKVlp0b1ufzxtogtIZ49v8UnrVja0IjmhOqHqi+kE/JkTPY20PYN+1kyDwqSM= Received: from pb-smtp1.nyi.icgroup.com (unknown [127.0.0.1]) by pb-smtp1.pobox.com (Postfix) with ESMTP id 137ACA3613; Wed, 18 Nov 2020 23:05:43 -0500 (EST) (envelope-from kyle@kyleam.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=kyleam.com; h=from:to:cc:subject:in-reply-to:references:date:message-id:mime-version:content-type:content-transfer-encoding; s=mesmtp; bh=QpLNuPt9xHxh6bkczJSzDJQyhRfbEYeL6/hLuViUyOc=; b=Eyovua+pt1/Zf88x/F1dVgiNhubaa3qmEc2ZgPjMdpGfRj+9/liKgYKlzxhr/jGjh0+QEL4picH2hUfOLtze9NWf5Q7kSzavmlrpi/7laOLae35o2EJWh+otHq2LSiyhNXenbFF6htR6OcQymjyz2Txxx4qWZpbs6Dt/vv+8ufo= Received: from localhost (unknown [45.33.91.115]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pb-smtp1.pobox.com (Postfix) with ESMTPSA id 75882A3612; Wed, 18 Nov 2020 23:05:42 -0500 (EST) (envelope-from kyle@kyleam.com) From: Kyle Meyer To: Greg Minshall Subject: Re: patch to change org-adapt-indentation customization documentation In-Reply-To: <926418.1605701588@apollo2.minshall.org> References: <926418.1605701588@apollo2.minshall.org> Date: Wed, 18 Nov 2020 23:05:41 -0500 Message-ID: <87r1oq0z56.fsf@kyleam.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Pobox-Relay-ID: 7DEB9B90-2A1C-11EB-8848-D152C8D8090B-24757444!pb-smtp1.pobox.com Received-SPF: pass client-ip=64.147.108.70; envelope-from=kyle@kyleam.com; helo=pb-smtp1.pobox.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/18 22:07:57 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Robert Pluim , Org-mode Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Scanner: ns3122888.ip-94-23-21.eu Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=pobox.com header.s=sasl header.b=vtkzj1cs; dkim=pass header.d=kyleam.com header.s=mesmtp header.b=Eyovua+p; dmarc=none; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Spam-Score: -1.21 X-TUID: S49hIwXRQNMm Greg Minshall writes: > hi, Robert, > > thanks. given that the docstring already talks about nil, t, > 'headline-data ... Not related to your main point, but if you're improving the docstring anyway: 'headline-data (which is a relatively recent addition) should instead be written as `headline-data' for consistency and to avoid worrying about needing to protect it from being confusingly rendered as "=E2=80=99headline-data" (depending on text-quoting-style). > should i eliminate those, just leaving "three" choices? > ---- >> "Adapt indentation for all lines" >> "Adapt indentation for headline data lines" >> "Do not adapt indentation at all" > ---- > or, leave mention of nil, t, 'headline-data, while trying to make > clearer the binding of the longer descriptions in the docstring to the > above short descriptions? > > i guess i see lots of emacs docstrings that talk of t, nil, etc. so, > maybe it's not inappropriate for them to be in the docstring. Please leave the values in the docstring. But any rewording of docstring that you think makes the customization labels easier to link to the docstring is welcome. > (but, in which case, then i wonder, why not mention them also in the > choices?) I'm sympathetic to Robert's "you shouldn't have to worry about what the actual lisp value is" stance. But I don't actually use the customize interface, so maybe that preference just comes from my impression that I never see the value in tag labels in source code. Crude grepping in the Emacs repo suggests it's rare (at least for nil): $ git grep 'const :tag ".*nil.*" nil' '*.el' lisp/bindings.el: (const :tag "nil: No offset is displayed" nil) lisp/comint.el: :type '(choice (const :tag "nil" nil) lisp/help.el: :type '(choice (const :tag "never (nil)" nil) lisp/ps-mule.el: (const bdf-font-except-latin) (const :ta= g "nil" nil)) lisp/ps-print.el: (const control) (const :tag "nil" nil)) lisp/ps-print.el: (const :tag "nil" nil)) lisp/scroll-bar.el: :type '(choice (const :tag "none (nil)" nil) lisp/so-long.el: (const :tag "nil: Call so-long as normal"= nil) lisp/so-long.el: (const :tag "nil: Use so-long-function as= normal" nil) lisp/textmodes/tex-mode.el: :type '(radio (const :tag "Interactive (nil)= " nil) $ git grep 'const :tag ".*" nil' '*.el' | wc -l 1064