Before I get to that, though -- it seem like some of this falls under
`style-guide.rst`. I've only been working with Julia for a few days and so
am hardly the one to be dictating style.

It seems me that in Julia, the style is to write almost no inline
documentation and instead write documents separately. This is as opposed to
Python where 80% of your typical source file is triple-quoted docstrings
and inline commentary.

The Julia advantage is that the documentation ends up reading like a
document whereas a lot of Python documentation extracted by Sphinx reads
like machine-generated goo.

The Python advantage is that it's more fun to read source code.

I don't know if this is an intentional design decision or just the way
things have worked out so far. What do people think? Pythonic? Or Julian?


On Tue, Nov 26, 2013 at 9:05 AM, Michael Fox <415fox@gmail.com> wrote:

> Fair enough. My goals are:
>
> 1. Document the existing, undocumented, feature of triple-quoted strings
> -- which are good for multi-line comments, doc strings, usage strings or
> anywhere you want to quote a quote.
>
> 2. Document the new feature of triple-quoted-regex strings.
>
> Anyway, I will rollback and write something better.
>
>
> On Tue, Nov 26, 2013 at 7:54 AM, Steven G. Johnson <
> notifications@github.com> wrote:
>
>> In doc/manual/strings.rst:
>>
>> > @@ -699,6 +699,27 @@ For example, the following regex has all three flags turned on:
>> >      julia> match(r"a+.*b+.*?d$"ism, "Goodbye,\nOh, angry,\nBad world\n")
>> >      RegexMatch("angry,\nBad world")
>> >
>> > +Sometimes you want use double-quotes in regular expressions. Escaping them can
>> > +be annoying. Now you can use tripple quotes.
>> > +
>> > +.. doctest::
>> > +
>> > +    julia> r = r"""
>> > +           "[^"]*"
>> > +           """xs
>> > +    r"
>> > +           \"[^\"]*\"
>> > +           "sx
>> > +
>> > +Triple-quoted strings have worked for a while now:
>>
>> I don't think this example is needed. match takes any string for its
>> second argument, and triple-quoted literals are just strings.
>>
>> —
>> Reply to this email directly or view it on GitHub<https://github.com/JuliaLang/julia/pull/4934/files#r7928335>
>> .
>>
>
>
>
> --
>
> -
> Michael
>



-- 

-
Michael