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: Opaque objects and Emacs documentation
Date: Fri, 24 Jul 2020 08:45:41 +0300
Message-ID: <83v9idea9m.fsf@gnu.org>
References: <20200712184908.13140.5739@vcs0.savannah.gnu.org>
 <20200712184909.BBC61209B1@vcs0.savannah.gnu.org>
 <7bf4d6ef-c0ec-43dc-ad5d-f6e81422ad90@yandex.ru> <83zh84m5ws.fsf@gnu.org>
 <3dd1c224-69b2-40af-5b2e-43a310253632@yandex.ru> <83tuybmtxs.fsf@gnu.org>
 <859f594b-1343-6d26-e1ac-7157c44eb56c@yandex.ru> <83a6zyk4tt.fsf@gnu.org>
 <jwvo8oekshk.fsf-monnier+emacs@gnu.org> <865zadhl1f.fsf@gmail.com>
 <af58f59e-eeed-513f-268f-c680af7b1ae9@yandex.ru>
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="35121"; mail-complaints-to="usenet@ciao.gmane.io"
Cc: andrewjmoreton@gmail.com, emacs-devel@gnu.org
To: Dmitry Gutov <dgutov@yandex.ru>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 24 07:46:41 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 1jyqXZ-00093q-I5
	for ged-emacs-devel@m.gmane-mx.org; Fri, 24 Jul 2020 07:46:41 +0200
Original-Received: from localhost ([::1]:43296 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 1jyqXY-0006j1-JI
	for ged-emacs-devel@m.gmane-mx.org; Fri, 24 Jul 2020 01:46:40 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55552)
 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 1jyqWs-0006J1-ME
 for emacs-devel@gnu.org; Fri, 24 Jul 2020 01:45:58 -0400
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:32836)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1jyqWs-00020h-Ak; Fri, 24 Jul 2020 01:45:58 -0400
Original-Received: from [176.228.60.248] (port=1169 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 1jyqWr-0005CI-PK; Fri, 24 Jul 2020 01:45:58 -0400
In-Reply-To: <af58f59e-eeed-513f-268f-c680af7b1ae9@yandex.ru> (message from
 Dmitry Gutov on Fri, 24 Jul 2020 03:43:41 +0300)
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:253179
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/253179>

> From: Dmitry Gutov <dgutov@yandex.ru>
> Date: Fri, 24 Jul 2020 03:43:41 +0300
> 
> Doesn't the Commentary cover most (all?) of the above?

Documenting stuff in the commentary is better than nothing, but it is
sub-optimal: our Help commands don't scan comments, so the information
that is only in comments is less discoverable, certainly by users.

Therefore, I think any information important to users should be in doc
strings and the manual, not just in comments.