[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread andy hayden
Thanks for that answer, that makes sense, I'll PR a mention of that on the documentation page. :) Did you see my comment here: https://github.com/JuliaLang/julia/issues/8966#issuecomment-70600813 I couldn't get a MetaDoc type working, but had a crack at it here: https://gist.github.com/hayd/b

Re: [julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Tim Holy
Better yet would be to put such information into the documentation page http://docs.julialang.org/en/latest/manual/documentation/ --Tim On Tuesday, January 20, 2015 09:43:32 AM Michael Hatherly wrote: > At the moment it’s main purpose is so that you can write literal $ > characters in your docstr

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Michael Hatherly
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 th

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread andy hayden
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 `ba

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Michael Hatherly
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

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Yuuki Soho
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

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Michael Hatherly
What version of Docile are you using? You can check with `Pkg.status()`. The current stable version is 0.3.2. Try doing `Pkg.update()` and then rerunning your file if you're not on that version. On Tuesday, 20 January 2015 16:17:07 UTC+2, Yuuki Soho wrote: > > My file was huge, but I did a minima

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Yuuki Soho
My file was huge, but I did a minimal one: if VERSION < v"0.4-" using Docile macro doc_mstr(text) Base.triplequoted(text) end macro doc_str(text) text end end @doc doc"Tells you if there are too foo items in the array." -> function test(x) r

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Michael Hatherly
Hi Yuuki, could you provide me with the complete example you tried? — Mike ​ On Tuesday, 20 January 2015 16:00:53 UTC+2, Yuuki Soho wrote: > > I just used the workaround but now I get another error: > > ERROR: No metadata defined in module Main. > > > I just copy-pasted one of the example from

[julia-users] Re: 0.4 Documentation System

2015-01-20 Thread Yuuki Soho
I just used the workaround but now I get another error: ERROR: No metadata defined in module Main. I just copy-pasted one of the example from the doc before one of my functions. v"0.3.2" On Tuesday, January 20, 2015 at 8:19:50 AM UTC+1, Michael Hatherly wrote: > > If anyone happens to run into

[julia-users] Re: 0.4 Documentation System

2015-01-19 Thread Michael Hatherly
If anyone happens to run into a ERROR: @doc_mstr not defined message when using Docile and the 0.4 doc system please have a look at this issue for the workaround. — Mike ​ On Tuesday, 20 January 2015 00:26:36 UTC+2, Mike Innes wrote: >

[julia-users] Re: 0.4 Documentation System

2015-01-19 Thread Ismael VC
Wonderful! El lunes, 19 de enero de 2015, 16:26:36 (UTC-6), Mike Innes escribió: > > Hey Julians, > > Just wanted to drop a note to say that the new documentation system now > has some of its own documentation in the manual > . This wil