-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Doctests confuse multi-paragraph footnote with indented code block #139064
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.
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
Labels
A-doctests
Area: Documentation tests, run by rustdoc
A-markdown-parsing
Area: Markdown parsing for doc-comments
C-bug
Category: This is a bug.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
camelid
added a commit
to camelid/rust
that referenced
this issue
Apr 9, 2025
We should enable these to avoid misinterpreting uses of the extended syntax as code blocks. This happens in practice with multi-paragraph footnotes, as discovered in rust-lang#139064.
camelid
added a commit
to camelid/rust
that referenced
this issue
Apr 9, 2025
We should enable these to avoid misinterpreting uses of the extended syntax as code blocks. This happens in practice with multi-paragraph footnotes, as discovered in rust-lang#139064.
Zalathar
added a commit
to Zalathar/rust
that referenced
this issue
Apr 10, 2025
rustdoc: Enable Markdown extensions when looking for doctests Fixes rust-lang#139064. We should enable these to avoid misinterpreting uses of the extended syntax as code blocks. This happens in practice with multi-paragraph footnotes, as discovered in rust-lang#139064.
Zalathar
added a commit
to Zalathar/rust
that referenced
this issue
Apr 10, 2025
rustdoc: Enable Markdown extensions when looking for doctests Fixes rust-lang#139064. We should enable these to avoid misinterpreting uses of the extended syntax as code blocks. This happens in practice with multi-paragraph footnotes, as discovered in rust-lang#139064.
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Apr 10, 2025
Rollup merge of rust-lang#139592 - camelid:doctest-md-opts, r=notriddle rustdoc: Enable Markdown extensions when looking for doctests Fixes rust-lang#139064. We should enable these to avoid misinterpreting uses of the extended syntax as code blocks. This happens in practice with multi-paragraph footnotes, as discovered in rust-lang#139064.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-doctests
Area: Documentation tests, run by rustdoc
A-markdown-parsing
Area: Markdown parsing for doc-comments
C-bug
Category: This is a bug.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
I tried this code:
This is a footnote with multiple paragraphs. It renders correctly in the documentation:
However, running as a doctest fails:
Somehow the doctest collector seems to not understand that there are footnotes. I would expect this to be ignored.
Meta
The text was updated successfully, but these errors were encountered: