-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Closed
Labels
A-doctestsArea: Documentation tests, run by rustdocArea: Documentation tests, run by rustdocA-markdown-parsingArea: Markdown parsing for doc-commentsArea: Markdown parsing for doc-commentsC-bugCategory: This is a bug.Category: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Description
Currently, it gives this error:
error[E0585]: found a documentation comment that doesn't document anything
--> /checkout/src/doc/rustdoc/src/what-to-include.md:68:1
|
7 | /// ```
| ^^^^^^^
|
= help: doc comments must come before what they document, maybe a comment was intended with `//`?
Rustdoc should always run doctests in markdown, since there's no code to document.
Originally posted by @jyn514 in #75778 (comment)
Metadata
Metadata
Assignees
Labels
A-doctestsArea: Documentation tests, run by rustdocArea: Documentation tests, run by rustdocA-markdown-parsingArea: Markdown parsing for doc-commentsArea: Markdown parsing for doc-commentsC-bugCategory: This is a bug.Category: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.