From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: module documentation draft Date: Fri, 29 Sep 2017 19:45:56 +0300 Message-ID: <83k20h78sb.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1506703633 5616 195.159.176.226 (29 Sep 2017 16:47:13 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 29 Sep 2017 16:47:13 +0000 (UTC) Cc: phst@google.com, aurelien.aptel@gmail.com, emacs-devel@gnu.org To: Philipp Stephani Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Sep 29 18:47:08 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dxyRO-0000uo-ED for ged-emacs-devel@m.gmane.org; Fri, 29 Sep 2017 18:47:06 +0200 Original-Received: from localhost ([::1]:36139 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxyRV-0005jG-VJ for ged-emacs-devel@m.gmane.org; Fri, 29 Sep 2017 12:47:13 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44737) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxyQT-0005aZ-T7 for emacs-devel@gnu.org; Fri, 29 Sep 2017 12:46:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dxyQP-0006SM-Vv for emacs-devel@gnu.org; Fri, 29 Sep 2017 12:46:09 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:49166) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxyQP-0006SA-QJ; Fri, 29 Sep 2017 12:46:05 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:1360 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dxyQP-0006X5-6N; Fri, 29 Sep 2017 12:46:05 -0400 In-reply-to: (message from Philipp Stephani on Thu, 28 Sep 2017 20:25:11 +0000) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:218915 Archived-At: > From: Philipp Stephani > Date: Thu, 28 Sep 2017 20:25:11 +0000 > > Thanks! I've also finally managed to get my draft online: > https://phst.github.io/emacs-modules > It's more specification-like and hopefully covers most of the behavior of the module API. > > It would be great if we could have comprehensive documentation in the ELisp manual in Emacs 26. So it > would be great if others (especially the maintainers) could review these two documents. Please focus on the > content during the first pass, not on stylistic or editorial issues. I already read this, when this was first announced in April. Unfortunately, the style and the methodology of the description differs significantly from what we use in the ELisp manual. So this text will have to be reworked, and I didn't yet find time to do it. If someone else would like to step forward, it would be great. The first step is to convert the tutorial-like description to the reference-style description we use in the manual. My assessment was that it would need a non-trivial amount of editorial work. TIA