Skip to content

rustdoc: rename issue-\d+.rs tests to have meaningful names (part 11) #136258

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

Merged
merged 4 commits into from
Jan 31, 2025
Merged

rustdoc: rename issue-\d+.rs tests to have meaningful names (part 11) #136258

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fdef34b
Add URL and `crate_name` to test cases
notriddle Jan 29, 2025
eb457da
rustdoc: rename `issue-\d+.rs` tests to have meaningful names
notriddle Jan 29, 2025
a1a55a2
Give 104145, 103463, and 31948 more descriptive names
notriddle Jan 30, 2025
c17d568
Direct link 108459 to issues -> pull redirect
notriddle Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...c/intra-doc/auxiliary/issue-103463-aux.rs → ...i/intra-doc/auxiliary/issue-103463-aux.rs
View file
Open in desktop
File renamed without changes.
3 changes: 3 additions & 0 deletions tests/rustdoc/intra-doc/issue-103463.rs → tests/rustdoc-ui/intra-doc/ice-103463.rs
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh yeah, this is quite a specific regression test. Any more descriptive file name probably doesn't do it justice (like priv-use).

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// https://github.com/rust-lang/rust/issues/103463
//@ check-pass

// The `Trait` is not pulled into the crate resulting in doc links in its methods being resolved.

//@ aux-build:issue-103463-aux.rs
Expand Down
3 changes: 3 additions & 0 deletions tests/rustdoc/intra-doc/issue-104145.rs → tests/rustdoc-ui/intra-doc/ice-104145.rs
View file
Open in desktop
Copy link
Member

@fmease fmease Jan 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I admit that all of these ICE regression tests are super niche and that likely nobody will ever look at them again but I think it's worth spending some words on these ^^'. What about sth. like extern-trait-local-impl or non-local-trait-local-impl (with or without the ice- prefix)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to have the ice prefix for test cases that have no assertions. It makes it clearer what's being tested.

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// https://github.com/rust-lang/rust/issues/104145
//@ check-pass

// Doc links in `Trait`'s methods are resolved because it has a local impl.

//@ aux-build:issue-103463-aux.rs
Expand Down
5 changes: 4 additions & 1 deletion tests/rustdoc/inline_cross/issue-28480.rs → ...ine_cross/doc-hidden-broken-link-28480.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// https://github.com/rust-lang/rust/issues/28480
#![crate_name="foobar"]

//@ aux-build:rustdoc-hidden-sig.rs
//@ build-aux-docs
//@ ignore-cross-compile
Expand All @@ -7,7 +10,7 @@
//@ has - '//a' 'u8'
extern crate rustdoc_hidden_sig;

//@ has issue_28480/struct.Bar.html
//@ has foobar/struct.Bar.html
//@ !has - '//a/@title' 'Hidden'
//@ has - '//a' 'u8'
pub use rustdoc_hidden_sig::Bar;
13 changes: 8 additions & 5 deletions tests/rustdoc/inline_cross/issue-31948-1.rs → ...e_cross/doc-hidden-module-impl-31948-1.rs
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doc-hidden-* is only half the truth, this also tests that trait impls of effectively private types aren't rendered. Maybe doc-hidden-or-priv-module-* or the like?

Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
// https://github.com/rust-lang/rust/issues/31948
#![crate_name="foobar"]

//@ aux-build:rustdoc-nonreachable-impls.rs
//@ build-aux-docs
//@ ignore-cross-compile

extern crate rustdoc_nonreachable_impls;

//@ has issue_31948_1/struct.Wobble.html
//@ has foobar/struct.Wobble.html
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Bark for'
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Woof for'
//@ !has - '//*[@class="impl"]//h3[@class="code-header"]' 'Bar for'
//@ !has - '//*[@class="impl"]//h3[@class="code-header"]' 'Qux for'
pub use rustdoc_nonreachable_impls::hidden::Wobble;

//@ has issue_31948_1/trait.Bark.html
//@ has foobar/trait.Bark.html
//@ has - '//h3[@class="code-header"]' 'for Foo'
//@ has - '//h3[@class="code-header"]' 'for Wobble'
//@ !has - '//h3[@class="code-header"]' 'for Wibble'
pub use rustdoc_nonreachable_impls::Bark;

//@ has issue_31948_1/trait.Woof.html
//@ has foobar/trait.Woof.html
//@ has - '//h3[@class="code-header"]' 'for Foo'
//@ has - '//h3[@class="code-header"]' 'for Wobble'
//@ !has - '//h3[@class="code-header"]' 'for Wibble'
pub use rustdoc_nonreachable_impls::Woof;

//@ !has issue_31948_1/trait.Bar.html
//@ !has issue_31948_1/trait.Qux.html
//@ !has foobar/trait.Bar.html
//@ !has foobar/trait.Qux.html
13 changes: 8 additions & 5 deletions tests/rustdoc/inline_cross/issue-31948-2.rs → ...e_cross/doc-hidden-module-impl-31948-2.rs
View file
Open in desktop
Copy link
Member

@fmease fmease Jan 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is accurate. Well, except that the test also checks for the absence of impl Bar for Wobble (Bar relates to the effectively private test cases) which I think doesn't make that much sense as a test case but yea.

Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
// https://github.com/rust-lang/rust/issues/31948
#![crate_name="foobar"]

//@ aux-build:rustdoc-nonreachable-impls.rs
//@ build-aux-docs
//@ ignore-cross-compile

extern crate rustdoc_nonreachable_impls;

//@ has issue_31948_2/struct.Wobble.html
//@ has foobar/struct.Wobble.html
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Qux for'
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Bark for'
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Woof for'
//@ !has - '//*[@class="impl"]//h3[@class="code-header"]' 'Bar for'
pub use rustdoc_nonreachable_impls::hidden::Wobble;

//@ has issue_31948_2/trait.Qux.html
//@ has foobar/trait.Qux.html
//@ has - '//h3[@class="code-header"]' 'for Foo'
//@ has - '//h3[@class="code-header"]' 'for Wobble'
pub use rustdoc_nonreachable_impls::hidden::Qux;

//@ !has issue_31948_2/trait.Bar.html
//@ !has issue_31948_2/trait.Woof.html
//@ !has issue_31948_2/trait.Bark.html
//@ !has foobar/trait.Bar.html
//@ !has foobar/trait.Woof.html
//@ !has foobar/trait.Bark.html
17 changes: 10 additions & 7 deletions tests/rustdoc/inline_cross/issue-31948.rs → ...ine_cross/doc-hidden-module-impl-31948.rs
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commit cfad7ad that created these files describes it as a "reachability" check. How about calling it "doc-reachability-impl"?

Original file line number Diff line number Diff line change
@@ -1,29 +1,32 @@
// https://github.com/rust-lang/rust/issues/31948
#![crate_name="foobar"]

//@ aux-build:rustdoc-nonreachable-impls.rs
//@ build-aux-docs
//@ ignore-cross-compile

extern crate rustdoc_nonreachable_impls;

//@ has issue_31948/struct.Foo.html
//@ has foobar/struct.Foo.html
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Bark for'
//@ has - '//*[@class="impl"]//h3[@class="code-header"]' 'Woof for'
//@ !has - '//*[@class="impl"]//h3[@class="code-header"]' 'Bar for'
//@ !has - '//*[@class="impl"]//h3[@class="code-header"]' 'Qux for'
pub use rustdoc_nonreachable_impls::Foo;

//@ has issue_31948/trait.Bark.html
//@ has foobar/trait.Bark.html
//@ has - '//h3[@class="code-header"]' 'for Foo'
//@ !has - '//h3[@class="code-header"]' 'for Wibble'
//@ !has - '//h3[@class="code-header"]' 'for Wobble'
pub use rustdoc_nonreachable_impls::Bark;

//@ has issue_31948/trait.Woof.html
//@ has foobar/trait.Woof.html
//@ has - '//h3[@class="code-header"]' 'for Foo'
//@ !has - '//h3[@class="code-header"]' 'for Wibble'
//@ !has - '//h3[@class="code-header"]' 'for Wobble'
pub use rustdoc_nonreachable_impls::Woof;

//@ !has issue_31948/trait.Bar.html
//@ !has issue_31948/trait.Qux.html
//@ !has issue_31948/struct.Wibble.html
//@ !has issue_31948/struct.Wobble.html
//@ !has foobar/trait.Bar.html
//@ !has foobar/trait.Qux.html
//@ !has foobar/struct.Wibble.html
//@ !has foobar/struct.Wobble.html
5 changes: 4 additions & 1 deletion tests/rustdoc/inline_cross/issue-32881.rs → ...tdoc/inline_cross/impl-dyn-trait-32881.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
// https://github.com/rust-lang/rust/issues/32881
#![crate_name="foobar"]

//@ aux-build:rustdoc-trait-object-impl.rs
//@ build-aux-docs
//@ ignore-cross-compile

extern crate rustdoc_trait_object_impl;

//@ has issue_32881/trait.Bar.html
//@ has foobar/trait.Bar.html
//@ has - '//h3[@class="code-header"]' "impl<'a> dyn Bar"
//@ has - '//h3[@class="code-header"]' "impl<'a> Debug for dyn Bar"

Expand Down
5 changes: 4 additions & 1 deletion tests/rustdoc/inline_cross/issue-33113.rs → tests/rustdoc/inline_cross/impl-ref-33113.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
// https://github.com/rust-lang/rust/issues/33113
#![crate_name="foobar"]

//@ aux-build:issue-33113.rs
//@ build-aux-docs
//@ ignore-cross-compile

extern crate bar;

//@ has issue_33113/trait.Bar.html
//@ has foobar/trait.Bar.html
//@ has - '//h3[@class="code-header"]' "for &'a char"
//@ has - '//h3[@class="code-header"]' "for Foo"
pub use bar::Bar;
2 changes: 2 additions & 0 deletions tests/rustdoc/inline_cross/issue-76736-1.rs → ...doc/inline_cross/rustc-private-76736-1.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// https://github.com/rust-lang/rust/issues/76736

//@ aux-build:issue-76736-1.rs
//@ aux-build:issue-76736-2.rs

Expand Down
2 changes: 2 additions & 0 deletions tests/rustdoc/inline_cross/issue-76736-2.rs → ...doc/inline_cross/rustc-private-76736-2.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// https://github.com/rust-lang/rust/issues/76736

//@ aux-build:issue-76736-1.rs
//@ aux-build:issue-76736-2.rs

Expand Down
2 changes: 2 additions & 0 deletions tests/rustdoc/inline_cross/issue-76736-3.rs → ...doc/inline_cross/rustc-private-76736-3.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// https://github.com/rust-lang/rust/issues/76736

//@ compile-flags: -Zforce-unstable-if-unmarked
//@ aux-build:issue-76736-1.rs
//@ aux-build:issue-76736-2.rs
Expand Down
2 changes: 2 additions & 0 deletions tests/rustdoc/inline_cross/issue-76736-4.rs → ...doc/inline_cross/rustc-private-76736-4.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// https://github.com/rust-lang/rust/issues/76736

//@ aux-build:issue-76736-1.rs
//@ aux-build:issue-76736-2.rs

Expand Down
0 ...sue-24183.method_no_where_self_sized.html → ...nds-24183.method_no_where_self_sized.html
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions tests/rustdoc/inline_cross/issue-24183.rs → ...c/inline_cross/self-sized-bounds-24183.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// https://github.com/rust-lang/rust/issues/24183
#![crate_type = "lib"]
#![crate_name = "usr"]

Expand Down
13 changes: 8 additions & 5 deletions tests/rustdoc/inline_local/issue-32343.rs → ...stdoc/inline_local/doc-no-inline-32343.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
//@ !has issue_32343/struct.Foo.html
//@ has issue_32343/index.html
// https://github.com/rust-lang/rust/issues/32343
#![crate_name="foobar"]

//@ !has foobar/struct.Foo.html
//@ has foobar/index.html
//@ has - '//code' 'pub use foo::Foo'
//@ !has - '//code/a' 'Foo'
#[doc(no_inline)]
pub use foo::Foo;

//@ !has issue_32343/struct.Bar.html
//@ has issue_32343/index.html
//@ !has foobar/struct.Bar.html
//@ has foobar/index.html
//@ has - '//code' 'pub use foo::Bar'
//@ has - '//code/a' 'Bar'
#[doc(no_inline)]
Expand All @@ -18,6 +21,6 @@ mod foo {
}

pub mod bar {
//@ has issue_32343/bar/struct.Bar.html
//@ has foobar/bar/struct.Bar.html
pub use ::foo::Bar;
}
7 changes: 5 additions & 2 deletions tests/rustdoc/inline_local/issue-28537.rs → ...stdoc/inline_local/pub-re-export-28537.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// https://github.com/rust-lang/rust/issues/28537
#![crate_name="foo"]

#[doc(hidden)]
pub mod foo {
pub struct Foo;
Expand All @@ -10,8 +13,8 @@ mod bar {
}
}

//@ has issue_28537/struct.Foo.html
//@ has foo/struct.Foo.html
pub use foo::Foo;

//@ has issue_28537/struct.Bar.html
//@ has foo/struct.Bar.html
pub use self::bar::Bar;
2 changes: 2 additions & 0 deletions tests/rustdoc/intra-doc/issue-82209.rs → tests/rustdoc/intra-doc/enum-self-82209.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// https://github.com/rust-lang/rust/issues/82209

#![crate_name = "foo"]
#![deny(rustdoc::broken_intra_doc_links)]
pub enum Foo {
Expand Down
11 changes: 7 additions & 4 deletions tests/rustdoc/intra-doc/issue-108459.rs → ...me-name-different-disambiguator-108459.rs
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(hah, [#]108459 isn't even an issue but a PR)

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// https://github.com/rust-lang/rust/issues/108459
#![crate_name="foobar"]

#![deny(rustdoc::broken_intra_doc_links)]
#![allow(rustdoc::redundant_explicit_links)]

Expand All @@ -13,13 +16,13 @@ pub struct MyStruct1;
// the same target but different text

/// See also [crate::char] and [mod@char] and [prim@char]
//@ has issue_108459/struct.MyStruct2.html '//*[@href="char/index.html"]' 'crate::char'
//@ has foobar/struct.MyStruct2.html '//*[@href="char/index.html"]' 'crate::char'
//@ has - '//*[@href="char/index.html"]' 'char'
//@ has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct2;

/// See also [mod@char] and [prim@char] and [crate::char]
//@ has issue_108459/struct.MyStruct3.html '//*[@href="char/index.html"]' 'crate::char'
//@ has foobar/struct.MyStruct3.html '//*[@href="char/index.html"]' 'crate::char'
//@ has - '//*[@href="char/index.html"]' 'char'
//@ has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct3;
Expand All @@ -28,11 +31,11 @@ pub struct MyStruct3;
// different targets

/// See also [char][mod@char] and [char][prim@char]
//@ has issue_108459/struct.MyStruct4.html '//*[@href="char/index.html"]' 'char'
//@ has foobar/struct.MyStruct4.html '//*[@href="char/index.html"]' 'char'
//@ has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct4;

/// See also [char][prim@char] and [char][crate::char]
//@ has issue_108459/struct.MyStruct5.html '//*[@href="char/index.html"]' 'char'
//@ has foobar/struct.MyStruct5.html '//*[@href="char/index.html"]' 'char'
//@ has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct5;
5 changes: 4 additions & 1 deletion tests/rustdoc/intra-doc/issue-66159.rs → ...a-doc/same-name-different-crates-66159.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// https://github.com/rust-lang/rust/issues/66159
#![crate_name="foobar"]

//@ aux-crate:priv:pub_struct=pub-struct.rs
//@ compile-flags:-Z unstable-options

Expand All @@ -6,5 +9,5 @@
// Since we don't generate the docs for the auxiliary files, we can't actually
// verify that the struct is linked correctly.

//@ has issue_66159/index.html
//@ has foobar/index.html
//! [pub_struct::SomeStruct]
Loading