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: ~Make emacs friendlier: package documentation [POC CODE INCLUDED]
Date: Thu, 15 Oct 2020 22:24:51 +0300
Message-ID: <83pn5jwav0.fsf@gnu.org>
References: <20201015190929.gdvx7j2yukcdcoaw@E15-2016.optimum.net>
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="7969"; mail-complaints-to="usenet@ciao.gmane.io"
Cc: emacs-devel@gnu.org
To: Boruch Baum <boruch_baum@gmx.com>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Oct 15 21:25:30 2020
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 1kT8sU-0001zg-7s
	for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Oct 2020 21:25:30 +0200
Original-Received: from localhost ([::1]:56314 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 1kT8sT-0002FB-7n
	for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Oct 2020 15:25:29 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51486)
 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 1kT8ru-0001mT-8D
 for emacs-devel@gnu.org; Thu, 15 Oct 2020 15:24:54 -0400
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:57348)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1kT8rt-0003qz-V6; Thu, 15 Oct 2020 15:24:53 -0400
Original-Received: from [176.228.60.248] (port=2606 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 1kT8rt-0004kl-7Z; Thu, 15 Oct 2020 15:24:53 -0400
In-Reply-To: <20201015190929.gdvx7j2yukcdcoaw@E15-2016.optimum.net> (message
 from Boruch Baum on Thu, 15 Oct 2020 15:09:29 -0400)
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:257760
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/257760>

> Date: Thu, 15 Oct 2020 15:09:29 -0400
> From: Boruch Baum <boruch_baum@gmx.com>
> 
> A programmer's idea of a friendly environment might be the opposite of a
> user's in that what programmer enjoys writing documentation, and having
> to repeat the process with almost identical text in more than place, and
> in more than one format. There are docstrings, and then there's the
> commentary at the top of the elisp file, and then any info file, and
> what else.
> 
> Attached is working proof-of-concept code to allow a user to easily get
> all a package's in-line documentation, in the format of an org-mode
> buffer, to cover cases where there is no info file, or to supplement the
> info file.

Thanks.  Does this do more/different things than "C-h P"?  AFAIK,
"C-h P" also uses the commentary part of a package's source file.  If
something is missing there, perhaps we could add or extend what
"C-h P" does?