[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Some ideas with Emacs
From: |
Emanuel Berg |
Subject: |
Re: Some ideas with Emacs |
Date: |
Sun, 01 Dec 2019 07:25:44 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux) |
Michael Albinus wrote:
> If a function is too complex to explain it in
> the docstring on, say one page of ~24 lines,
> one shall document it more verbose in the
> manual. Examples, if not necessary for
> understanding the docstring, shall be shown
> in the manual. In such cases, there shall be
> a link to the manual in the docstring.
The more links to the manual, the better!
I don't think I've seen a single such link BTW,
but maybe I didn't look close enough. How do
you even include such a link when writing
a docstring?
> If a function requires an exhaustive
> docstring, it could be an option to break it
> into several functions.
Absolutely, bare that in mind.
--
underground experts united
http://user.it.uu.se/~embe8573
https://dataswamp.org/~incal
Re: Some ideas with Emacs, Richard Stallman, 2019/12/01
Re: Some ideas with Emacs, Richard Stallman, 2019/12/01
Re: Some ideas with Emacs, Emanuel Berg, 2019/12/01
Re: Some ideas with Emacs,
Emanuel Berg <=
Re: Some ideas with Emacs, Emanuel Berg, 2019/12/01
Re: Some ideas with Emacs, Emanuel Berg, 2019/12/01
Re: Some ideas with Emacs, Emanuel Berg, 2019/12/01
Re: Some ideas with Emacs, Stefan Monnier, 2019/12/01