From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Some ideas with Emacs Date: Fri, 29 Nov 2019 22:30:38 +0200 Message-ID: <83r21qo26p.fsf@gnu.org> 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> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="174149"; mail-complaints-to="usenet@blaine.gmane.org" Cc: emacs-devel@gnu.org, stefan@marxist.se, monnier@iro.umontreal.ca, c4droid@foxmail.com To: Michael Albinus Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Nov 29 21:31:59 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 1iamvn-000jAG-HM for ged-emacs-devel@m.gmane.org; Fri, 29 Nov 2019 21:31:59 +0100 Original-Received: from localhost ([::1]:35036 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iamvl-0007Ow-V8 for ged-emacs-devel@m.gmane.org; Fri, 29 Nov 2019 15:31:57 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51186) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iamuK-0006r2-3x for emacs-devel@gnu.org; Fri, 29 Nov 2019 15:30:29 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:51549) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iamuH-0006zy-Ax; Fri, 29 Nov 2019 15:30:25 -0500 Original-Received: from [176.228.60.248] (port=3065 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1iamuG-0005Ne-Lw; Fri, 29 Nov 2019 15:30:25 -0500 In-reply-to: <8736e6e8fn.fsf@gmx.de> (message from Michael Albinus on Fri, 29 Nov 2019 21:25:48 +0100) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:242894 Archived-At: > From: Michael Albinus > Cc: monnier@iro.umontreal.ca, stefan@marxist.se, c4droid@foxmail.com, > emacs-devel@gnu.org > Date: Fri, 29 Nov 2019 21:25:48 +0100 > > 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. > > If a function requires an exhaustive docstring, it could be an option > to break it into several functions. > > Maybe all of this is too restrictive. But you see the intention. I don't think I'd mind, provided that it's worded as guidelines, not as rigid rules.