From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Michael Albinus Newsgroups: gmane.emacs.devel Subject: Re: Some ideas with Emacs Date: Sun, 01 Dec 2019 11:21:38 +0100 Message-ID: <87k17gcpn1.fsf@gmx.de> References: <837e3iq0ks.fsf@gnu.org> <87h82my0fm.fsf@gmx.de> <83tv6mo4vl.fsf@gnu.org> <878snyxx5d.fsf@gmx.de> <83sgm6o2y1.fsf@gnu.org> <8736e6e8fn.fsf@gmx.de> <864kyksgt3.fsf@zoho.eu> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="239704"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Dec 01 11:24:21 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1ibMOn-00109w-3J for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 11:24:17 +0100 Original-Received: from localhost ([::1]:49708 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibMOl-0005pP-Nb for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 05:24:15 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59670) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibMMJ-0005p2-KZ for emacs-devel@gnu.org; Sun, 01 Dec 2019 05:21:44 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ibMMI-0004nF-Ck for emacs-devel@gnu.org; Sun, 01 Dec 2019 05:21:43 -0500 Original-Received: from mout.gmx.net ([212.227.17.21]:54319) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ibMMI-0004ka-04 for emacs-devel@gnu.org; Sun, 01 Dec 2019 05:21:42 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1575195699; bh=ERyqBGNLERqvQlrhFE+qskaivF16Nh3VIN/gHux6cFQ=; h=X-UI-Sender-Class:From:To:Subject:References:Date:In-Reply-To; b=e9Xzr1eMMcCpgouQOd80taUBf7ZrLaj3Ky4LPGMK+Df4iLmYjm14FMvaYW14v3KIB /RNAs3AlzAbgKhg2dx7I1IFF1E1We26hKamgsyFyV57caToKjN4QQ5JMa6WDxj49Lb aBBjo+NPEddMaJhbWz9PLILrIg29MD43mF5SQcCw= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from detlef.gmx.de ([213.220.146.93]) by mail.gmx.com (mrgmx105 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MQv8x-1iOUCb3Q07-00O2G1 for ; Sun, 01 Dec 2019 11:21:38 +0100 In-Reply-To: <864kyksgt3.fsf@zoho.eu> (Emanuel Berg via's message of "Sun, 01 Dec 2019 07:25:44 +0100") X-Provags-ID: V03:K1:+MoAqR85yO1dUF9xL+BxrHS1AiTuFEm/D3QEGVcAqvqOI4sG4Wn N3LZjLMUcRWQrfOyARwNNASRrgtZEHoKDqHs5qAUmCgVBu/XpDoA89OsSgBnqwpylfirWlY zUaXDX+118HzK7dzXaeLGeq3RDeT2lZLF/FasAl353LWTZj7EfwSspa5wBjfcWW1aGflj/F 2Z64Kap5PtOXApMpOG8RQ== X-UI-Out-Filterresults: notjunk:1;V03:K0:euArbnMaha8=:GHqrh0/obux12OToVR+xD2 SY/gI4Q1uvuiHL52MPl7moCC2Fp1j3LoBmHSPSzX5tErlSCfPmKLqe7UvG92CdJRTx3L8dar0 SpYoRUIBeB5W6BgPSkOC3i4ptCNYb+DcNlBBbDEqMAnWIhtH1flowNlGR/ILzPY2KeCM18WNW QVSWCUjmCWA6S9neNUMYD2i2RCKebTca6a0DOwzqxx48CvH46LX9cyW1Vp76O7fim0etG6Kme 2Ma3/9rFDY8ebQKDnQ1R7E8FjlPRXACMChyX/miIqOVCSETHilb9wJi8eBLviq9Q2jhTF9AyI Y9bkmBfnvQGpGnFzVQOjqZEyGDXjQnk9Kyp1ObfONzc7Fh+L67MfG77S2F1Qly9qYM2bY0kVe yuYn8REU+4RFL8pTvM/IIJTW47W5pqVOvtJ4dYX8wO7vfUfPj3a3jnXLbLd+lP/7zamYaB30T mV/1a0jCO4ttO+JTyPeFIWhbkAQeiQ87LnPq6bTTheJIqGl/FXaerzmeiTjFOSCfVxjd/WdD1 Q013CN432XoWULZkE+cgO421kz+QvtCSZRPWXwDxft7NuzTIjn/eAemLhlqzJrFFz/NiahraU 7Dkm7XY1/Kpe/s48szkCTsrFP4dHn60MZLvgpJwhzX5dJYuMWsBsEtK410V5tV3chwZir775e JIEO1WgEtKSfeBTrJJWP2pDAKEGWS2xtZvGwdBtYRQEARvtGcCGbGrZluhUYhj+iGnNSc5aFD tnPbVaYqJDP5RbaSCh3UYJToliEUO73aFCKtyYZYcoAXe0lplk9XVvM4WAhW7o0UpJ+HYl8e X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 212.227.17.21 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:242946 Archived-At: Emanuel Berg via "Emacs development discussions." writes: > 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.