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 "’headline-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 :tag "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
