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.

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

Ungreat change to doctest test names #70090

Closed
ehuss opened this issue Mar 18, 2020 · 8 comments · Fixed by #73842
Closed

Ungreat change to doctest test names #70090

ehuss opened this issue Mar 18, 2020 · 8 comments · Fixed by #73842
Labels
A-doctests Area: Documentation tests, run by rustdoc A-macros Area: All kinds of macros (custom derive, macro_rules!, proc macros, ..) C-bug Category: This is a bug. regression-from-stable-to-stable Performance or correctness regression from one stable version to another. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@ehuss
Copy link
Contributor

ehuss commented Mar 18, 2020

Doctest test names have changed due to #66364. Doc comments that pass through a macro defined in another crate now seem to report a different span.

lazy_static::lazy_static! {
    /// Comments
    /// ```
    /// assert!(true);
    /// ```
    static ref FOO: bool = true;
}

running with cargo test --doc previously looked like this:

test <::lazy_static::__lazy_static_internal macros> - FOO (line 26) ... ok

Now the test names look like this:

test /Users/eric/.cargo/registry/src/github.com-1ecc6299db9ec823/lazy_static-1.4.0/src/lib.rs - FOO (line 159) ... ok

Frankly, neither are particularly great. It would be nice if the test name used the span from where the macro was invoked, not where it was defined.

rustc 1.43.0-nightly (c20d7eecb 2020-03-11)

@ehuss ehuss added the C-bug Category: This is a bug. label Mar 18, 2020
@matthiaskrgr

This comment has been minimized.

@jonas-schievink jonas-schievink added A-doctests Area: Documentation tests, run by rustdoc T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-macros Area: All kinds of macros (custom derive, macro_rules!, proc macros, ..) I-nominated regression-from-stable-to-stable Performance or correctness regression from one stable version to another. labels Mar 18, 2020
@Centril
Copy link
Contributor

Centril commented Mar 18, 2020

cc @eddyb @petrochenkov

@eddyb
Copy link
Member

eddyb commented Mar 18, 2020

@matthiaskrgr What you're describing is entirely in the opposite direction, <::std::macros::panic macros> is the old (and arguably bad) kind of Span that's impossible to get anymore.
I've hidden your comment to focus on the reported issue.

@eddyb
Copy link
Member

eddyb commented Mar 18, 2020

@ehuss That makes sense, we have a way to get the outermost invocation, that is used by file!()/line! and #[track_caller]:

span.ctxt().outer_expn().expansion_cause().unwrap_or(span)

We'd just need to use this in rustdoc.

@Centril
Copy link
Contributor

Centril commented Mar 18, 2020

cc @GuillaumeGomez

@spastorino spastorino removed the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Mar 18, 2020
@Centril
Copy link
Contributor

Centril commented Mar 18, 2020

cc @rust-lang/rustdoc

@spastorino
Copy link
Member

spastorino commented Mar 18, 2020

Removed T-compiler label, left nomination for T-rustdoc to decide about this issue.

@GuillaumeGomez
Copy link
Member

Well, using what @eddyb suggested seems like the best thing to do.

@spastorino spastorino added I-prioritize Issue: Indicates that prioritization has been requested for this issue. and removed I-prioritize Issue: Indicates that prioritization has been requested for this issue. labels May 21, 2020
bors added a commit to rust-lang-ci/rust that referenced this issue Aug 7, 2020
Use outermost invocation span for doctest names

Fixes rust-lang#70090.

This PR also allows using aux-build files in rustdoc-ui tests.
@bors bors closed this as completed in 6088079 Aug 7, 2020
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-macros Area: All kinds of macros (custom derive, macro_rules!, proc macros, ..) C-bug Category: This is a bug. regression-from-stable-to-stable Performance or correctness regression from one stable version to another. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants