From: Eli Zaretskii <eliz@gnu.org>
To: emacs-devel@gnu.org
Subject: Updating manuals
Date: Sat, 18 Oct 2008 22:12:58 +0200 [thread overview]
Message-ID: <ud4hxll11.fsf@gnu.org> (raw)
Having invested now 5 days in updating the ELisp manual, I'm quite
sure we should request that each code contribution be accompanied with
some meaningful documentation, even if it's not valid Texinfo. The
amount of research that is needed to convert a short and at times
cryptic NEWS entry into a decent manual style description, and while
at that find and fix all the inaccuracies in the related doc strings,
is simply overwhelming. The person who writes the code in the first
place is in a much better position to describe that, especially around
the time the code is written. By contrast, fixing English and the
Texinfo markup is a rather mechanical job that takes much less effort.
Therefore not being a native English speaker should not be an excuse
for not writing documentation to go with the code.
Judging by the rather small progress I made during these 5 days (30
NEWS entries, with about 120 entries more remaining, including those
describing internationalization and multi-tty, which will require a
_really_ serious effort), I am now quite sure we are in trouble with
the prospective schedule of the pretest and release, unless much more
people will come on board to work on updating the manuals. (I could
only invest this many hours because it's a public holiday down here,
and it's almost over.)
next reply other threads:[~2008-10-18 20:12 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-10-18 20:12 Eli Zaretskii [this message]
2008-10-19 2:45 ` Updating manuals Chong Yidong
2008-10-19 7:28 ` Eli Zaretskii
2008-10-19 14:55 ` Chong Yidong
2008-10-20 1:13 ` Richard M. Stallman
2008-10-20 8:33 ` 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=ud4hxll11.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
/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.