Storing the doc string as plain text with markdown syntax would be the best way to go I think. The front end viewer (repl, IJulia, Jewel, etc) could then just pick the best renderer to display it with.
On Thursday, 12 June 2014 14:43:46 UTC+2, Mike Innes wrote: > > Is there a particular reason to document functions as opposed to just > methods? I would have thought that documentation for the most generic > method + some specific methods where necessary would be enough. It's best > if documentation is as simple as possible – we do want to encourage people > to use it. > > Personally I'll be happy if documentation looks exactly as Stefan has > suggested. Custom formatting might be a useful feature, but I think it's > best if plain docs are treated as Markdown by default – having consistency > in the way code blocks etc. are formatted will be helpful even when viewing > documentation as plain text, especially now that we can view Markdown in > the terminal. >
