[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Some ideas with Emacs

From: Michael Albinus
Subject: Re: Some ideas with Emacs
Date: Sun, 01 Dec 2019 11:21:38 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)

Emanuel Berg via "Emacs development discussions." <address@hidden>

> 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?

C-h v tramp-methods

See at the end of the docstring, the "Notes:" part.

The docstring is much too long, according to my own rules. It is a good
example for moving part of it into the manual.

Best regards, Michael.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]