From: Philipp Stephani <p.stephani2@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: phst@google.com, aurelien.aptel@gmail.com, emacs-devel@gnu.org
Subject: Re: module documentation draft
Date: Fri, 29 Sep 2017 20:39:15 +0000 [thread overview]
Message-ID: <CAArVCkTwce+Z62y+mrXZxLO7CAjuTpEGQFxWytP3t8qhK=fPyg@mail.gmail.com> (raw)
In-Reply-To: <83k20h78sb.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 1432 bytes --]
Eli Zaretskii <eliz@gnu.org> schrieb am Fr., 29. Sep. 2017 um 18:46 Uhr:
> > 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.
>
As said, I'd like to get feedback about the *content*. Changing the *style*
is easier and requires less discussion.
>
> The
> first step is to convert the tutorial-like description to the
> reference-style description we use in the manual.
>
I'm a bit surprised that you call my style "tutorial-like". I think it's
not a tutorial at all; there's e.g. no end-to-end example to step-by-step
instructions.
What exactly would you want to have changed to turn it into "reference
style"?
[-- Attachment #2: Type: text/html, Size: 2138 bytes --]
next prev parent reply other threads:[~2017-09-29 20:39 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
2017-09-29 16:49 ` Aurélien Aptel
2017-09-29 18:08 ` Eli Zaretskii
2017-09-29 20:39 ` Philipp Stephani [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAArVCkTwce+Z62y+mrXZxLO7CAjuTpEGQFxWytP3t8qhK=fPyg@mail.gmail.com' \
--to=p.stephani2@gmail.com \
--cc=aurelien.aptel@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.