Skip to content

Consider a different tooltip for a partially ignored doctest #141092

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

Open
ehuss opened this issue May 16, 2025 · 0 comments · May be fixed by #141517
Open

Consider a different tooltip for a partially ignored doctest #141092

ehuss opened this issue May 16, 2025 · 0 comments · May be fixed by #141517
Assignees
Labels
A-doctests Area: Documentation tests, run by rustdoc A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@ehuss
Copy link
Contributor

ehuss commented May 16, 2025

When a doctest is partially ignored based on target, such as:

/// Example
///
/// ```ignore-wasm
/// let x = 1;
/// ```
pub fn f() {}

the documentation includes an alert that the example isn't tested (on any target):

Image

This could be a little misleading, since the ignore statement could be for a relatively esoteric platform. But the docs seem to imply it isn't tested anywhere.

I'm not really sure what would make sense to include here. Perhaps the tooltip could be more explicit on what is being ignored?

Meta

rustdoc 1.89.0-nightly (414482f6a 2025-05-13)
binary: rustdoc
commit-hash: 414482f6a0d4e7290f614300581a0b55442552a3
commit-date: 2025-05-13
host: aarch64-apple-darwin
release: 1.89.0-nightly
LLVM version: 20.1.4
@ehuss ehuss added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-doctests Area: Documentation tests, run by rustdoc labels May 16, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label May 16, 2025
@fmease fmease added C-bug Category: This is a bug. A-rustdoc-ui Area: Rustdoc UI (generated HTML) and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels May 16, 2025
@rustbot rustbot added the T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. label May 16, 2025
@lolbinarycat lolbinarycat self-assigned this May 24, 2025
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-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

4 participants