Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

comments.md doesn't know about //! #26801

Closed
ErinCall opened this issue Jul 5, 2015 · 3 comments
Closed

comments.md doesn't know about //! #26801

ErinCall opened this issue Jul 5, 2015 · 3 comments

Comments

@ErinCall
Copy link

ErinCall commented Jul 5, 2015

The chapter on comments discusses two types of comments: // comments and /// doc comments. The section on testing mentions a third type: //! module doc comments. Should src/doc/trpl/comments.md be updated to include //!, or have I misunderstood something?

I'd be happy to help update the docs, but I thought I should make sure I know what's going on before I start telling everyone else :)
@bluss
Copy link
Member

bluss commented Jul 5, 2015

The reference lists all four (or six) syntaxes for doc comments. Maybe mentioning //! is a good idea for the book though.

@steveklabnik
Copy link
Member

Yeah, I would not be opposed to describing //! in the comments section as well.

liigo added a commit to liigo/rust that referenced this issue Jul 6, 2015
@liigo
book: introduce //! doc comment in comments section
03afbf9 
Closes rust-lang#26801
@liigo liigo mentioned this issue Jul 6, 2015
Merged
bors added a commit that referenced this issue Jul 6, 2015
@bors
Auto merge of #26820 - liigo:patch-2, r=steveklabnik
7b78538 
Closes #26801
@ErinCall
Copy link
Author

ErinCall commented Jul 6, 2015

Thanks y'all! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ErinCall @steveklabnik @bluss