From: Damien Doligez <Damien.Doligez@inria.fr>
To: caml-list@pauillac.inria.fr
Subject: Re: [Caml-list] Documentation tools
Date: Tue, 15 May 2001 06:24:13 +0200 (MET DST) [thread overview]
Message-ID: <200105150424.GAA0000023003@beaune.inria.fr> (raw)
>From: "Benjamin C. Pierce" <bcpierce@saul.cis.upenn.edu>
>
>So I would not like to see us decide on a documentation tool that
>requires *every* entry in every interface file to be annotated with some
>kind of heavy markup like a big pile of html/docbook tags. A small
>amount of extra cruft in interfaces is acceptable, but please let's not
>make all our .mli files totally unreadable for the sake of generating
>fancy docs.
I couldn't agree more !! I would absolutely hate to be forced to
write my comments in some non-human-readable language such as HTML (or
any other instance of SGML/XML). In my opinion, unobtrusiveness is a
lot more important than any fancy feature like <blink> or
<img src="http://cristal.inria.fr/~harley/ecdl7/pics/planar.gif">.
</blink>
You want titles and subtitles, font change for code, enumerations,
maybe some escape mechanism to write formulas in LaTeX, a way of
producing cross-references, and that's it. Everything else is
overhead.
-- Damien
-------------------
To unsubscribe, mail caml-list-request@inria.fr. Archives: http://caml.inria.fr
next reply other threads:[~2001-05-15 4:24 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-05-15 4:24 Damien Doligez [this message]
2001-05-15 9:42 ` Markus Mottl
2001-05-16 22:13 ` [Caml-list] " Joseph R. Kiniry
-- strict thread matches above, loose matches on Subject: below --
2001-05-14 8:11 [Caml-list] " Xavier Leroy
2001-05-14 11:28 ` Sven LUTHER
2001-05-14 12:22 ` Benjamin C. Pierce
2001-05-14 13:12 ` Peter Ronnquist
2001-05-14 13:32 ` Christian Lindig
2001-05-14 14:26 ` Stefan Monnier
2001-05-14 14:36 ` markus.kliegl
2001-05-14 18:04 ` Emmanuel LEDINOT
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=200105150424.GAA0000023003@beaune.inria.fr \
--to=damien.doligez@inria.fr \
--cc=caml-list@pauillac.inria.fr \
/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.
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 NNTP newsgroup(s).