Re: master 48aacbf292 2/2: Make many seldom-used generalized variables obsolete

[Ihor Radchenko]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>>> Would it be possible to accept docstring in gv-define-setter and then
>>> display it in the help buffer for the relevant variable?
>> It would be possible, but then we'd just be encouraging people to write
>> illegible code.
>
> Largely agreed.  There is some occasional need for documentation of the
> setter, for example we could argue that `alist-get` (when used as a gv)
> should document that the ALIST argument needs to be a gv-place as
> well.  But when needed it can be added to the function's docstring.
> So, I'm leaning towards YAGNI.

I do not have anything against this paradigm.
However, it would be useful then to document this convention in
"12.17.2 Defining new ‘setf’ forms" section of the Elisp manual.

-- 
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92