From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Jean-Christophe Helary Newsgroups: gmane.emacs.devel Subject: Re: Imports / inclusion of s.el into Emacs Date: Mon, 4 May 2020 16:35:53 +0900 Message-ID: <6C836138-819D-4D1C-982C-72F49867997E@traduction-libre.org> References: <831ro2tqqx.fsf@gnu.org> <4a1fd3f4-df92-c756-9874-4d07b54148ac@yandex.ru> <83v9lesapw.fsf@gnu.org> <83pnbms9m8.fsf@gnu.org> <83a72qs4z2.fsf@gnu.org> <83wo5uqoh5.fsf@gnu.org> <838si9qf7s.fsf@gnu.org> <83pnblov3t.fsf@gnu.org> Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.80.23.2.2\)) Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="123953"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org, joaotavora@gmail.com, Dmitry Gutov , Eli Zaretskii , Yuri Khan , Stefan Monnier To: Richard Stallman Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon May 04 09:38:31 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 1jVVgM-000WAD-W6 for ged-emacs-devel@m.gmane-mx.org; Mon, 04 May 2020 09:38:30 +0200 Original-Received: from localhost ([::1]:57632 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jVVgM-0006Zf-1i for ged-emacs-devel@m.gmane-mx.org; Mon, 04 May 2020 03:38:30 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33120) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jVVfe-0005hH-4c for emacs-devel@gnu.org; Mon, 04 May 2020 03:37:46 -0400 Original-Received: from relay8-d.mail.gandi.net ([217.70.183.201]:58141) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jVVfc-0004Wr-9n; Mon, 04 May 2020 03:37:45 -0400 X-Originating-IP: 128.53.210.217 Original-Received: from [10.0.1.13] (pl6361.ag0304.nttpc.ne.jp [128.53.210.217]) (Authenticated sender: jean.christophe.helary@traduction-libre.org) by relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 880A51BF207; Mon, 4 May 2020 07:35:57 +0000 (UTC) In-Reply-To: X-Mailer: Apple Mail (2.3608.80.23.2.2) Received-SPF: pass client-ip=217.70.183.201; envelope-from=jean.christophe.helary@traduction-libre.org; helo=relay8-d.mail.gandi.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/05/04 03:37:39 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN 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:248793 Archived-At: > On May 4, 2020, at 12:09, Richard Stallman wrote: >> API lists are not tutorials. They are the reference manual, just >> presented in a very condensed form. A user who is moderately >> experienced with an API but has not committed it into memory will >> sometimes forget exact names of functions, and a concise API list = will >> refresh his/her memory just enough to continue coding. >=20 > That's a valid point. >=20 > I think we could generate API lists like these > automatically from the text of the Emacs Lisp Ref Manual. > Just search through the chosen node (and its subnodes) for > definition constructs, and process them to get calling sequences. >=20 > Would someone like to try writing that? There was a similar proposal in June 2017 in a thread titled "docstrings = and elisp reference" where I suggested that the docstrings could be used = for that purpose. Considering that docstrings describe more functions than the manual = does, would you think that working on the dosctrings for what you = describe above would be better to expose emacs' APIs ? Jean-Christophe Helary ----------------------------------------------- http://mac4translators.blogspot.com @brandelune