Skip to content

Some descriptions beginning with /// in docs #24410

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
Closed
killercup opened this issue Apr 14, 2015 · 2 comments
Closed

Some descriptions beginning with /// in docs #24410

killercup opened this issue Apr 14, 2015 · 2 comments
Labels
A-macros Area: All kinds of macros (custom derive, macro_rules!, proc macros, ..) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@killercup
Copy link
Member

In the std::str API docs, some Struct descriptions beginn with ///.

std__str_-_rust

Some of these structs are generated by macros, e.g. Matches here.
@killercup killercup changed the title Shows Some Descriptions Beginning with /// in Docs Some descriptions beginning with /// in docs Apr 14, 2015
@Kimundi Kimundi added the A-macros Area: All kinds of macros (custom derive, macro_rules!, proc macros, ..) label Apr 14, 2015
@Kimundi
Copy link
Member

Kimundi commented Apr 14, 2015

Its an issue with doc comments taken as an attribute in a macro. cc @kmcallister

@alexcrichton alexcrichton added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 14, 2015
@pyfisch
Copy link
Contributor

pyfisch commented Apr 14, 2015

Duplicate of #23812

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-macros Area: All kinds of macros (custom derive, macro_rules!, proc macros, ..) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@killercup @steveklabnik @alexcrichton @pyfisch @Kimundi