At the moment it’s main purpose is so that you can write literal $
characters in your docstrings without
worrying about inadvertent string interpolation. Quite handy if you’re
writing latex in your docstrings.
— Mike
On Tuesday, 20 January 2015 19:11:26 UTC+2, andy hayden wrote:
>
> One thing that seems unclear, at least to me, is the distinction (if any)
> between doc"...", md"..." (md isn't exported in Base) and "..." (just a
> string).
>
> It doesn't seem that it matters which we use e.g. the following are
> equivalent:
>
> @doc "foo `bar` baz" -> function foo() end
> @doc doc"foo `bar` baz" -> function foo() end
>
> On Tuesday, 20 January 2015 09:02:31 UTC-8, Michael Hatherly wrote:
>>
>> No problem, glad that part’s working now.
>>
>> To view Docile-generated help you need to call using Lexicon, which
>> hooks into Julia’s help system and adds the help entries generated by
>> Docile. If you’ve not got Lexicon installed you can call
>> Pkg.add("Lexicon") to install it.
>>
>> — Mike
>> On Tuesday, 20 January 2015 18:35:20 UTC+2, Yuuki Soho wrote:
>>>
>>> I had a problem with my packages (it was even crashing on update...), I
>>> reinstalled the packages from scratch and the error is gone. I should have
>>> checked that first, sorry.
>>>
>>> That said I'm not sure it's working properly, that's what I get (I
>>> renamed the test function above test1):
>>>
>>> help?> test1
>>> INFO: Loading help data...
>>> test1 (generic function with 1 method)
>>>
>>>
