From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: =?UTF-8?Q?Aur=C3=A9lien_Aptel?= Newsgroups: gmane.emacs.devel Subject: Re: module documentation draft Date: Thu, 28 Sep 2017 23:51:36 +0200 Message-ID: References: NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" X-Trace: blaine.gmane.org 1506635511 17714 195.159.176.226 (28 Sep 2017 21:51:51 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 28 Sep 2017 21:51:51 +0000 (UTC) Cc: Philipp Stephani , Emacs development discussions To: Philipp Stephani , Tom Tromey Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Sep 28 23:51:45 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 1dxgie-00045T-5V for ged-emacs-devel@m.gmane.org; Thu, 28 Sep 2017 23:51:44 +0200 Original-Received: from localhost ([::1]:32817 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxgil-0004yr-DW for ged-emacs-devel@m.gmane.org; Thu, 28 Sep 2017 17:51:51 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:45414) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxgia-0004yh-Qo for emacs-devel@gnu.org; Thu, 28 Sep 2017 17:51:41 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dxgiZ-00080z-Qp for emacs-devel@gnu.org; Thu, 28 Sep 2017 17:51:40 -0400 Original-Received: from mail-pg0-x22d.google.com ([2607:f8b0:400e:c05::22d]:50925) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dxgiZ-0007z2-L0 for emacs-devel@gnu.org; Thu, 28 Sep 2017 17:51:39 -0400 Original-Received: by mail-pg0-x22d.google.com with SMTP id p5so1644023pgn.7 for ; Thu, 28 Sep 2017 14:51:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=IZ1f7Ph/cwVThkvgIgG7NbLLT3Rjn+1FlR+5JRxlYnQ=; b=POehAvcLfKv81IzuWRe9yrLXB4ZvMk9vCR6/L50QD4pGk66lzllg463h1xhaal72pA qgQ5+l9LxJv9if60xyXADIVPGEsngWwn7c+KE48MCxsfykzF1KnrKWBhReKbAqXHqafr dE5g5D7Kk58NnTKgY+HGBhrobKDrI+6U4cmSG6J55nHwGw7xtosuEs9JTGJ08u2lznzz vOR6aBPfq8ZUWrxmp/+gC6yWvxvqljptxWgMqDvIG5em6Re5OTUMb8RuHMV3Y/aADqrm SHO4khD9q91RNoz6o1b5dUmD8gkW9Iay5c911X6q8jFtMohLOW3yEsEIZabFqJEIfAIZ FRIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=IZ1f7Ph/cwVThkvgIgG7NbLLT3Rjn+1FlR+5JRxlYnQ=; b=g4nPDT83vriuYf1eluIONIMHV2NrqyMseqZ3Ou3pzAHIRPNMUAYyxYt+MOfAGsFRmb wF+6mjLZVKF6aMku2imP7VwlIfe9GUARAX+O5Jg5qgztTbpcfIxTo4s+yuxyNcH2er0M XWxzNu0pwCylPYJzvVaAppyeHiFZPGhUmiXja7GCMVuRhM6pbtmzSZp1X6kd6jS/sbhn bRSN32Qv8EIoeY8kTLOsAmKZQHKHaRXzDcTxRard4xVLb6eoyEiPXb/jzlmwILyjrHcc HMj++sdqJRRo9D4de9gAdemResVjULRC2S0RQuMfRbs2fNCKjBC9s5ivsHXzLADk678h OVtw== X-Gm-Message-State: AHPjjUjLkHLASCF4SvGLXnUgcgQBKX0sqyHgaiBXkJfQ9NgD7gBtSnCr hfWcgffeYaNuJm06Xj4LC4GWsbjp/mcD9QgZVe23/Q== X-Google-Smtp-Source: AOwi7QC4/YWQXHKRMeeWK6upUNmGNg5MNo1xetInRzX1K105IpE5i/99StGNGsTpLsuMBGj/nM5swIvkfWpFRiWwX+Y= X-Received: by 10.84.238.207 with SMTP id l15mr4943380pln.194.1506635496910; Thu, 28 Sep 2017 14:51:36 -0700 (PDT) Original-Received: by 10.100.182.138 with HTTP; Thu, 28 Sep 2017 14:51:36 -0700 (PDT) In-Reply-To: X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:400e:c05::22d 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:218872 Archived-At: On Thu, Sep 28, 2017 at 10:25 PM, Philipp Stephani wrote: > 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 remember finding a couple of mistakes from copy/pasting and typos but otherwise I think the structure is good. I'll make a PR to fix those. I think it would be nice to have full of a properly written simple module as an example. Perhaps my tutorial could be a start. I know the makefile is not portable but it's something. Also Chris Wellon has written 2 posts about how he used modules. It provides a good feedback, I'd suggest reading those (I think he wrote them *before* you wrote the docs): http://nullprogram.com/blog/2016/11/05/ http://nullprogram.com/blog/2017/02/14/ In the second one in particular he uses unix signals as a way to do async communication from a module function. I think it's really interesting. It reminded me of the discussions we had elsewhere with Tom Tromey about adding a way to push special events in emacs event queue to do something similar. cheers,