From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Emanuel Berg via "Emacs development discussions." Newsgroups: gmane.emacs.devel Subject: Re: Some ideas with Emacs Date: Sun, 01 Dec 2019 07:25:44 +0100 Message-ID: <864kyksgt3.fsf@zoho.eu> 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> Reply-To: Emanuel Berg Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="105243"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Dec 01 07:26:53 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 1ibIh1-000REV-AE for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 07:26:51 +0100 Original-Received: from localhost ([::1]:41096 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibIh0-0005Ax-1R for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 01:26:50 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37814) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibIg8-00058e-To for emacs-devel@gnu.org; Sun, 01 Dec 2019 01:25:57 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ibIg7-0001e3-Rh for emacs-devel@gnu.org; Sun, 01 Dec 2019 01:25:56 -0500 Original-Received: from 195-159-176-226.customer.powertech.no ([195.159.176.226]:60312 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ibIg7-0001bb-Fk for emacs-devel@gnu.org; Sun, 01 Dec 2019 01:25:55 -0500 Original-Received: from list by blaine.gmane.org with local (Exim 4.89) (envelope-from ) id 1ibIg5-000QMc-Hk for emacs-devel@gnu.org; Sun, 01 Dec 2019 07:25:53 +0100 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: emacs-devel@gnu.org Mail-Copies-To: never Cancel-Lock: sha1:RhrSLIaCkAIBPvRn96hj2en8KU0= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 195.159.176.226 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:242939 Archived-At: 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