From: Eli Zaretskii <eliz@gnu.org>
To: Philipp Stephani <p.stephani2@gmail.com>
Cc: phst@google.com, aurelien.aptel@gmail.com, emacs-devel@gnu.org
Subject: Re: module documentation draft
Date: Fri, 29 Sep 2017 19:45:56 +0300 [thread overview]
Message-ID: <83k20h78sb.fsf@gnu.org> (raw)
In-Reply-To: <CAArVCkQCQmsF1voQq5MnOv9rnr=k63hMOgZzmrKnb9U68LBhZw@mail.gmail.com> (message from Philipp Stephani on Thu, 28 Sep 2017 20:25:11 +0000)
> From: Philipp Stephani <p.stephani2@gmail.com>
> 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
next prev parent reply other threads:[~2017-09-29 16:45 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
2017-09-29 16:45 ` Eli Zaretskii [this message]
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=83k20h78sb.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=aurelien.aptel@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=p.stephani2@gmail.com \
--cc=phst@google.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).