Re: [julia-users] Re: Sublists in Julia's doc strings
Ah, that wasn't clear. Might just be another enhancement request for the Markdown parser, then? On Friday, June 5, 2015 at 12:28:53 PM UTC-5, Scott Jones wrote: I was not asking about that, but rather that Julia's Markdown handling doesn't seem to be handling sublists as the Markdown examples I've seen... which I showed in the doc string... Sent from my iPhone On Jun 5, 2015, at 5:02 PM, Patrick O'Leary patrick.ole...@gmail.com wrote: 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 docSilly 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
Re: [julia-users] Re: Sublists in Julia's doc strings
I was not asking about that, but rather that Julia's Markdown handling doesn't seem to be handling sublists as the Markdown examples I've seen... which I showed in the doc string... Sent from my iPhone On Jun 5, 2015, at 5:02 PM, Patrick O'Leary patrick.ole...@gmail.com wrote: 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 docSilly 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
[julia-users] Re: Sublists in Julia's doc strings
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 docSilly 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
