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: Sat, 30 Sep 2017 00:03:17 +0300 [thread overview]
Message-ID: <83a81d5iay.fsf@gnu.org> (raw)
In-Reply-To: <CAArVCkTwce+Z62y+mrXZxLO7CAjuTpEGQFxWytP3t8qhK=fPyg@mail.gmail.com> (message from Philipp Stephani on Fri, 29 Sep 2017 20:39:15 +0000)
> From: Philipp Stephani <p.stephani2@gmail.com>
> Date: Fri, 29 Sep 2017 20:39:15 +0000
> Cc: aurelien.aptel@gmail.com, phst@google.com, emacs-devel@gnu.org
>
> 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.
I said "style and methodology", and we seem to disagree about what is
and isn't "style". My "style" is part of your "content".
> 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.
I already said I won't argue about the "tutorial" part, so let's drop
it.
> What exactly would you want to have changed to turn it into "reference style"?
It's hard to explain without doing the actual work. For starters, it
is too formal: begins by introducing all the terms, even if that's far
from where they are actually needed in the description; talks about
requirements before describing the interesting stuff; etc. Then the
order of the sections doesn't always make sense to me: for example,
"Compatibility" should be somewhere near the end. And there are other
issues.
Doesn't reading a typical chapter in the ELisp manual, such as "Hash
Tables" or "Processes", make the differences clear?
Or let me turn the table and ask you: do you think that text is fit
for putting it as-is into the ELisp manual?
next prev parent reply other threads:[~2017-09-29 21:03 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
2017-09-29 21:03 ` Eli Zaretskii [this message]
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=83a81d5iay.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).