(That's exactly what this parenthetical is clarifying)


On Sun, Nov 24, 2013 at 11:35 PM, Corey Richardson <corey@octayn.net> wrote:

> No.
>
>
> On Sun, Nov 24, 2013 at 11:34 PM, Steven Fackler <notifications@github.com
> > wrote:
>
>> In doc/rust.md:
>>
>> >  line_comment : "//" non_eol * ;
>> >  ~~~~
>> >
>> >  Comments in Rust code follow the general C++ style of line and block-comment forms,
>> >  with no nesting of block-comment delimiters.
>> >
>> > -Line comments beginning with _three_ slashes (`///`),
>> > -and block comments beginning with a repeated asterisk in the block-open sequence (`/**`),
>> > -are interpreted as a special syntax for `doc` [attributes](#attributes).
>> > -That is, they are equivalent to writing `#[doc "..."]` around the comment's text.
>> > +Line comments beginning with exactly _three_ slashes (`///`), and block
>> > +comments beginning with a exactly one repeated asterisk in the block-open
>> > +sequence (`/**`), are interpreted as a special syntax for `doc`
>> > +[attributes](#attributes).  That is, they are equivalent to writing
>> > +`#[doc="..."]` around the body of the comment (this includes the comment
>> > +characters themselves, ie `/// Foo` turns into `#[doc="/// Foo"]`.
>>
>> Shouldn't this be #[doc="Foo"]?
>>
>> —
>> Reply to this email directly or view it on GitHub<https://github.com/mozilla/rust/pull/10642/files#r7882777>
>> .
>>
>
>