From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.devel Subject: RE: Opaque objects and Emacs documentation Date: Fri, 24 Jul 2020 17:21:36 +0000 (UTC) Message-ID: <5a31ce31-576c-4f4a-8334-bf6982baf258@default> 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> <865zadhl1f.fsf@gmail.com> <83v9idea9m.fsf@gnu.org> <91040299-384b-b952-7273-4da432ecb1ea@yandex.ru> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16617"; mail-complaints-to="usenet@ciao.gmane.io" Cc: andrewjmoreton@gmail.com, emacs-devel@gnu.org To: Dmitry Gutov , Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 24 19:22:37 2020 Return-path: 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 ) id 1jz1P1-00049M-EG for ged-emacs-devel@m.gmane-mx.org; Fri, 24 Jul 2020 19:22:35 +0200 Original-Received: from localhost ([::1]:35520 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jz1P0-0003Ez-Ft for ged-emacs-devel@m.gmane-mx.org; Fri, 24 Jul 2020 13:22:34 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37678) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jz1OD-0002N9-1E for emacs-devel@gnu.org; Fri, 24 Jul 2020 13:21:45 -0400 Original-Received: from aserp2120.oracle.com ([141.146.126.78]:43864) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jz1OA-0008WL-SN; Fri, 24 Jul 2020 13:21:44 -0400 Original-Received: from pps.filterd (aserp2120.oracle.com [127.0.0.1]) by aserp2120.oracle.com (8.16.0.42/8.16.0.42) with SMTP id 06OH7Qo8162040; Fri, 24 Jul 2020 17:21:40 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2020-01-29; bh=eyFjfMOGuLMziTWsTlQFsKlXZRWiss5UWnWz06yCwBY=; b=bsm0IUiuOEvyEs43nsx/HmXnQe/i5WJE7M2bawzdUYFheEk4nRLO0lAveSysdVmv7L0P aPd4RJdyd+14foe8OZeff0ULiEfGtdqpSX9oZ/n1Fo5EDsMTOQmyhDSg1YjyOQI97OfF A1DBYkm9f1xKvcDM4HNS5RiUdnW2tAM0OvgG/o0kJDikOKpMIGtI5qKN25ilJdPFXr6+ UMzDYF+ulSiGw3P3S/0rhgUCT/hZRKehNOlvJaAEGN07EUSQSmhrnALBhv8PSpGKO6DD AVNogiUJhFjO9swtIW28U2UYYRDHqtI9iE68YmMFuXLVfRKeSXF8v63dp4FXuGpjsqc9 hQ== Original-Received: from userp3030.oracle.com (userp3030.oracle.com [156.151.31.80]) by aserp2120.oracle.com with ESMTP id 32bs1n09ry-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Fri, 24 Jul 2020 17:21:40 +0000 Original-Received: from pps.filterd (userp3030.oracle.com [127.0.0.1]) by userp3030.oracle.com (8.16.0.42/8.16.0.42) with SMTP id 06OH9A5n184795; Fri, 24 Jul 2020 17:21:39 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by userp3030.oracle.com with ESMTP id 32g3dwabgs-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Jul 2020 17:21:39 +0000 Original-Received: from abhmp0016.oracle.com (abhmp0016.oracle.com [141.146.116.22]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id 06OHLciW008159; Fri, 24 Jul 2020 17:21:38 GMT In-Reply-To: <91040299-384b-b952-7273-4da432ecb1ea@yandex.ru> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.5017.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9692 signatures=668680 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 suspectscore=1 malwarescore=0 mlxlogscore=999 spamscore=0 phishscore=0 adultscore=0 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2006250000 definitions=main-2007240131 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9692 signatures=668680 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 bulkscore=0 adultscore=0 lowpriorityscore=0 mlxlogscore=999 malwarescore=0 clxscore=1011 spamscore=0 mlxscore=0 impostorscore=0 phishscore=0 priorityscore=1501 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2006250000 definitions=main-2007240131 Received-SPF: pass client-ip=141.146.126.78; envelope-from=drew.adams@oracle.com; helo=aserp2120.oracle.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/07/24 12:57:41 X-ACL-Warn: Detected OS = Linux 3.1-3.10 [fuzzy] X-Spam_score_int: -63 X-Spam_score: -6.4 X-Spam_bar: ------ X-Spam_report: (-6.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H2=-1, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:253198 Archived-At: > >> 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. >=20 > We do have 'M-x describe-package', though (C-h P). And there is `finder-commentary'. It could be bound to a help key (`C-h '). The version of `finder-commentary' I have in `finder+.el' names the buffer `*Commentary, *' where is the file the Commentary is from, not just `*Finder-package*'. That labels it well, and lets you easily have more than one such help buffer. https://www.emacswiki.org/emacs/download/finder%2b.el https://www.emacswiki.org/emacs/FinderMode > > Therefore, I think any information important to > > users should be in doc strings and the manual, > > not just in comments. I agree with that. (But I also think that a helpful Commentary is a good thing, and I miss the Commentary sections of yesteryear.)