From: Jean Saint-Remy <jeansaintremy@yahoo.com>
To: OCaml Mailing List <caml-list@inria.fr>
Subject: [Caml-list] what is the proper way to write a help system in ocaml
Date: Wed, 11 Mar 2015 01:34:21 +0000 (UTC) [thread overview]
Message-ID: <946009894.3251241.1426037661902.JavaMail.yahoo@mail.yahoo.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 722 bytes --]
Bonjour mon ami,
Maybe this subject is off the topic of writing good ocaml code. Even Real World Ocaml does not seem to devote a single paragraph to the topic of developing a good end-user help system. The ocaml manual is an excellent example of self-documenting code. But I've most enjoyed reading Lucas Saiu code base in the project called Marionnet. There building a virtual network is no simple task. Without a good help system even the most abitious program is as useless as tits on a boar. In Marionnet there are seperate texi files that explain how to build and how to configure a virtual network lab. Would you say this is a better approach than using .chm help system in a program like Microsoft excel?
Thank you
[-- Attachment #2: Type: text/html, Size: 1166 bytes --]
reply other threads:[~2015-03-11 1:34 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=946009894.3251241.1426037661902.JavaMail.yahoo@mail.yahoo.com \
--to=jeansaintremy@yahoo.com \
--cc=caml-list@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