From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail
From: Eli Zaretskii <eliz@gnu.org>
Newsgroups: gmane.emacs.devel
Subject: Re: Some ideas with Emacs
Date: Fri, 29 Nov 2019 22:14:14 +0200
Message-ID: <83sgm6o2y1.fsf@gnu.org>
References: <tencent_62132B59F40D0E9645A7AC1AC33FD7724808@qq.com>
 <CADwFkm=PmEhfd=HyUJCyYAuGXYPAwN-9bYsk74eNQkRbWAVYhQ@mail.gmail.com>
 <837e3iq0ks.fsf@gnu.org>
 <CADwFkmmc+7mVATXi_u5Gd5CydJQCxg5My+X38=jX3M665t4Pcw@mail.gmail.com>
 <jwvtv6mzohw.fsf-monnier+emacs@gnu.org> <87h82my0fm.fsf@gmx.de>
 <83tv6mo4vl.fsf@gnu.org> <878snyxx5d.fsf@gmx.de>
Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226";
	logging-data="106890"; 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 <michael.albinus@gmx.de>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Nov 29 21:16:12 2019
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org>
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 <emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org>)
	id 1iamgU-000RfS-T1
	for ged-emacs-devel@m.gmane.org; Fri, 29 Nov 2019 21:16:11 +0100
Original-Received: from localhost ([::1]:34978 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org>)
	id 1iamgT-00074G-G1
	for ged-emacs-devel@m.gmane.org; Fri, 29 Nov 2019 15:16:09 -0500
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51758)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>) id 1iamea-0006Rb-IJ
 for emacs-devel@gnu.org; Fri, 29 Nov 2019 15:14:14 -0500
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:51411)
 by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <eliz@gnu.org>)
 id 1iameT-00087J-1M; Fri, 29 Nov 2019 15:14:05 -0500
Original-Received: from [176.228.60.248] (port=2044 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256)
 (Exim 4.82) (envelope-from <eliz@gnu.org>)
 id 1iameO-0004Py-SA; Fri, 29 Nov 2019 15:14:01 -0500
In-reply-to: <878snyxx5d.fsf@gmx.de> (message from Michael Albinus on Fri, 29
 Nov 2019 21:09:18 +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." <emacs-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/emacs-devel>
List-Post: <mailto:emacs-devel@gnu.org>
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=subscribe>
Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org
Original-Sender: "Emacs-devel" <emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org>
Xref: news.gmane.org gmane.emacs.devel:242891
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/242891>

> From: Michael Albinus <michael.albinus@gmx.de>
> Cc: monnier@iro.umontreal.ca,  stefan@marxist.se,  c4droid@foxmail.com,
>   emacs-devel@gnu.org
> Date: Fri, 29 Nov 2019 21:09:18 +0100
> 
> >> Personally, I don't like docstring to be too verbose. Usually, when a
> >> function is documented with both docstrings and a manual, I prefer to
> >> put the examples in the manual.
> >
> > I agree: the examples should be mostly in the manual.  Doc strings
> > should only have examples if it is otherwise very hard to explain
> > something.
> 
> Shall we say something like this in "(elisp) Documentation Tips"?

Not sure I understand what would you like to say there.