unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Aurélien Aptel" <aurelien.aptel@gmail.com>
To: Philipp Stephani <p.stephani2@gmail.com>, Tom Tromey <tom@tromey.com>
Cc: Philipp Stephani <phst@google.com>,
	Emacs development discussions <emacs-devel@gnu.org>
Subject: Re: module documentation draft
Date: Thu, 28 Sep 2017 23:51:36 +0200	[thread overview]
Message-ID: <CA+5B0FN5eFp94gSbdQ61vnRskM9jxC8YDwaQB2KjGmrhzHNKrw@mail.gmail.com> (raw)
In-Reply-To: <CAArVCkQCQmsF1voQq5MnOv9rnr=k63hMOgZzmrKnb9U68LBhZw@mail.gmail.com>

On Thu, Sep 28, 2017 at 10:25 PM, Philipp Stephani
<p.stephani2@gmail.com> 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,



  reply	other threads:[~2017-09-28 21:51 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-24 17:04 module documentation draft Aurélien Aptel
2017-07-23 18:57 ` Philipp Stephani
2017-07-25 12:50   ` Aurélien Aptel
2017-09-28 20:25   ` Philipp Stephani
2017-09-28 21:51     ` Aurélien Aptel [this message]
2017-09-29 16:45     ` Eli Zaretskii
2017-09-29 16:49       ` Aurélien Aptel
2017-09-29 18:08         ` Eli Zaretskii
2017-09-29 20:39       ` Philipp Stephani
2017-09-29 21:03         ` Eli Zaretskii
2017-12-26 21:06           ` Philipp Stephani
2018-10-11 18:01             ` Eli Zaretskii
2018-10-14 15:47               ` Basil L. Contovounesios
2018-10-14 16:14                 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CA+5B0FN5eFp94gSbdQ61vnRskM9jxC8YDwaQB2KjGmrhzHNKrw@mail.gmail.com \
    --to=aurelien.aptel@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=p.stephani2@gmail.com \
    --cc=phst@google.com \
    --cc=tom@tromey.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).