In violent agreement :-) My concern is sprawl...

/PA

On Sat, 15 Nov 2025 at 12:53, Ihor Radchenko <[email protected]> wrote:

> Pedro Andres Aranda Gutierrez <[email protected]> writes:
>
> >> The small one: should we drop the description field and always use the
> >> first line of the docstring for menu titles? This feels much smoother.
> >
> > That depends on how you craft either... Don't docstrings tend to grow
> (even
> > their first line)?
>
> No, the first line cannot grow. At least, if we do follow the docstring
> conventions that ask to keep the first line within fill-column:
>
>    • Format the documentation string so that it fits in an Emacs window
>      on an 80-column screen.  It is a good idea for most lines to be no
>      wider than 60 characters.  The first line should not be wider than
>      74 characters, or it will look bad in the output of ‘apropos’.
>
> So, using the first line is generally ok as long as what we are
> concerned is avoiding sprawl.
>
> --
> Ihor Radchenko // yantar92,
> Org mode maintainer,
> 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>
>


-- 
Fragen sind nicht da, um beantwortet zu werden,
Fragen sind da um gestellt zu werden
Georg Kreisler

"Sagen's Paradeiser" (ORF: Als Radiohören gefährlich war) => write BE!
Year 1 of the New Koprocracy

Reply via email to