Since this is a very C-style interface, perhaps `man 2 open` which uses 
that style of option flag will get you somewhere?

On Friday, June 5, 2015 at 7:47:49 AM UTC-5, Scott Jones wrote:
>
> I've been trying to write documentation for my Julia functions in a way 
> that others will find acceptable,
> but will still be useful to me.
> I have a keyword argument, options, that has several different possible 
> values or'ed in.
> I would like to describe that, but it doesn't come out nicely:
>
> @doc doc"""Silly function
>
> long description
> ### Input Arguments:
> 1. abc  Description of argument
> 2. def  Description of argument
>
> ### Keyword Argument:
> * options
>
>   **option1  Description of option 1
>   **option2  Description of option 2
>
> ### Returns:
>   * A UTF32String
>
> ### Throws:
>   * ArgumentError
> """ -> foo
>
>
>

Reply via email to