Google Groups Home
Help | Sign in
Documenting arguments ?
There are currently too many topics in this group that display first. To make this topic appear first, remove this option from another topic.
There was an error processing your request. Please try again.
flag
  1 message - Collapse all
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
Fabrice Marchant  
View profile
 More options Apr 6, 11:11 am
From: Fabrice Marchant <fabrice.march...@orange.fr>
Date: Sun, 6 Apr 2008 17:11:01 +0200
Local: Sun, Apr 6 2008 11:11 am
Subject: Documenting arguments ?
  Hi !

  Maybe is it a good place to post such a question here ?

 Not an OCaml specific question, however I'm trying to feed properly the 'doc' field for 'Arg.parse'.

Unix command :
man man
says :

bold text          type exactly as shown.
italic text        replace with appropriate argument.
[-abc]             any or all arguments within [ ] are optional.
-a|-b              options delimited by | cannot be used together.
argument ...       argument is repeatable.
[expression] ...   entire expression within [ ] is repeatable.

(However, outside a man page, when we type --help, there is nothing bold neither italic.)

Please is there additional documentation / examples about documentation conventions somewhere ?

  For example, how to describe, in the 'usage', a list of unrepeatable 'unit' options - their order being significant ?
(At this syntactic level, is it even possible to describe that some option cannot be repeated ?)
  Can I use '|' to say that, if any anonymous argument is provided, it will be impossible to specify some integer parameters ?

Any light ?

Fabrice


    Reply to author    Forward  
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
End of messages
« Back to Discussions « Newer topic     Older topic »

Create a group - Google Groups - Google Home - Terms of Service - Privacy Policy
©2008 Google