From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Eli Zaretskii <eliz@gnu.org>
Newsgroups: gmane.emacs.devel
Subject: Re: Add hints to documentation of car and cdr for (e)lisp newcomers -
 take 2
Date: Thu, 15 Jul 2021 17:14:18 +0300
Message-ID: <831r7z7jgl.fsf@gnu.org>
References: <8735shrl57.fsf@tullinup.koldfront.dk> <83v95c7v3v.fsf@gnu.org>
 <87bl74evd7.fsf@gnus.org>
 <CADwFkm=diMzMaKpf-N=WcDp_TJLsG-S=jzBsjj1qCWTeXVJ+pQ@mail.gmail.com>
 <87bl74ry2z.fsf@gnus.org>
 <CADwFkmmicLcDDadb7kdsMuJijgRygeud70Dzdxnbfm6iQ9mTGA@mail.gmail.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="12716"; mail-complaints-to="usenet@ciao.gmane.io"
Cc: larsi@gnus.org, asjo@koldfront.dk, emacs-devel@gnu.org
To: Stefan Kangas <stefan@marxist.se>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jul 15 16:15:46 2021
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Envelope-to: ged-emacs-devel@m.gmane-mx.org
Original-Received: from lists.gnu.org ([209.51.188.17])
	by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1m429S-00037D-6t
	for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 16:15:46 +0200
Original-Received: from localhost ([::1]:44512 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1m429R-0007m2-5u
	for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 10:15:45 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51882)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>) id 1m428M-00077H-PH
 for emacs-devel@gnu.org; Thu, 15 Jul 2021 10:14:38 -0400
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:49558)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1m428K-0004CI-5b; Thu, 15 Jul 2021 10:14:36 -0400
Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:4287
 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>)
 id 1m428J-0007i7-PQ; Thu, 15 Jul 2021 10:14:36 -0400
In-Reply-To: <CADwFkmmicLcDDadb7kdsMuJijgRygeud70Dzdxnbfm6iQ9mTGA@mail.gmail.com>
 (message from Stefan Kangas on Thu, 15 Jul 2021 13:39:54 +0200)
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-mx.org@gnu.org
Original-Sender: "Emacs-devel"
 <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Xref: news.gmane.io gmane.emacs.devel:271246
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/271246>

> From: Stefan Kangas <stefan@marxist.se>
> Date: Thu, 15 Jul 2021 13:39:54 +0200
> Cc: Eli Zaretskii <eliz@gnu.org>, Adam Sjøgren <asjo@koldfront.dk>, 
> 	Emacs developers <emacs-devel@gnu.org>
> 
> In general, I think we should include more examples in our
> documentation.  shortdoc.el is a step forward here, and it would be
> even better if you could see those examples when you pull up the
> docstring of a function.

IMO, examples are for the manual, not for the doc strings.  If some
parts of our manuals could benefit from more examples, patches for
that would be welcome.