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

rustdoc does not clarify that examples need to be prepended with /// #50816

Closed
jamesray1 opened this issue May 17, 2018 · 3 comments · Fixed by #50852
Closed

rustdoc does not clarify that examples need to be prepended with /// #50816

jamesray1 opened this issue May 17, 2018 · 3 comments · Fixed by #50852
Labels
C-bug Category: This is a bug. C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jamesray1
Copy link

See https://users.rust-lang.org/t/are-the-comments-about-using-in-rustdoc-outdated/17477 for details. Let me know if anything needs clarification.
@Centril Centril added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. labels May 17, 2018
@GuillaumeGomez
Copy link
Member

cc @rust-lang/docs

@QuietMisdreavus
Copy link
Member

Oh! That could use some clarification. Thanks for the report!

@jamesray1
Copy link
Author

You're welcome!

@mandeep mandeep mentioned this issue May 18, 2018
Merged
@frewsxcv frewsxcv added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels May 28, 2018
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Jun 5, 2018
@Mark-Simulacrum
Rollup merge of rust-lang#50852 - mandeep:fix-rustdoc-example-testing…
bcba3b9 
…, r=GuillaumeGomez

Add doc comment to hiding portions of code example

fixes rust-lang#50816

Not sure if this is all that's needed, but I think it's a good start. One thing to note is that the code block is a text block where it could possibly be a rust block.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-bug Category: This is a bug. C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add doc comment to hiding portions of code example mandeep/rust
5 participants
@frewsxcv @Centril @GuillaumeGomez @QuietMisdreavus @jamesray1