Conversation
|
r? @pcwalton (rust_highfive has picked a reviewer for you, use r? to override) |
|
If doctests pass for this locally, let me know (post review) and I'll include it in the current rollup. |
|
They all pass for me: |
|
Awesome, thanks. Will rollup when this gets an r+ |
src/doc/trpl/documentation.md
Outdated
There was a problem hiding this comment.
This enum example seems to be placed very prominently for something of an edge case? Maybe I'm missing how often it occurs.
Also, it's not not clear to me what "this" is and how it interacts with the position of doc-comments.
There was a problem hiding this comment.
I've heard people ask about it two or three times, they're not used to comments being anything but 'ignore this'
|
Is the name "Rustdoc" or "rustdoc"? |
|
|
883ae3f to
ccea16d
Compare
|
@huonw largely updated, one or two questions remaining |
|
@huonw ping! |
There was a problem hiding this comment.
"document"/"documentation" has been said a lot in the three paragraphs from line 35 to this one; maybe things could be tweaked to be a little more streamlined?
There was a problem hiding this comment.
Also, I'm still unsure what "this" is here? (It's not clear to me why rust keeping track of the comments is important for enums in particular.)
There was a problem hiding this comment.
"This" refers to the previous sentence: Rust understanding comments, rather than just ignoring them. I don't think most languages have documentation-specific comments, this behavior is different than people expect.
This chapter covers writing documentation in depth.
Fixes #4361
Fixes #12862
Fixes #14070
Fixes #14967