Skip to content

Tracking issue for moving rustdoc* tests to appropriate subdirs #136501

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
13 tasks
lolbinarycat opened this issue Feb 3, 2025 · 17 comments
Open
13 tasks

Tracking issue for moving rustdoc* tests to appropriate subdirs #136501

lolbinarycat opened this issue Feb 3, 2025 · 17 comments
Assignees
Labels
A-technical-debt Area: Internal cleanup work A-testsuite Area: The testsuite used to check the correctness of rustc C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-tedious Call for participation: An issue involves lots of work and is better handled as many small tasks. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@lolbinarycat
Copy link
Contributor

lolbinarycat commented Feb 3, 2025

Lots of tests could be moved into an existing subdir to be categorized more accurately.

Tests are grouped first by testsuite, then by where they should be moved to.

rustdoc-ui

rustdoc-ui/lints/

  • custom_code_classes_in_docs-warning3.rs
  • diagnostic-width.rs
  • include-str-bare-urls.rs
  • remap-path-prefix-lint.rs
  • unescaped_backticks.rs
  • unportable-markdown.rs
  • redundant-explicit-links-123677.rs

rustdoc-ui/intra-doc

  • circular-intra-doc-link-48414.rs
  • disambiguator-endswith-named-suffix.rs

rustdoc-ui/deref

  • deref-generic.rs
  • ice-blanket-impl-56701.rs
  • recursive-deref-ice.rs

rustdoc

rustdoc/doc-cfg

  • duplicate-cfg.rs
@lolbinarycat lolbinarycat added A-technical-debt Area: Internal cleanup work A-testsuite Area: The testsuite used to check the correctness of rustc C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 3, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Feb 3, 2025
@yegeunyang
Copy link
Contributor

@rustbot claim

@jieyouxu jieyouxu removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Feb 3, 2025
@lolbinarycat
Copy link
Contributor Author

@yegeunyang could you hold off on this until #136400 is merged? otherwise whichever PR isn't merged first will have a bunch of annoying merge conflicts.

@yegeunyang
Copy link
Contributor

@yegeunyang could you hold off on this until #136400 is merged? otherwise whichever PR isn't merged first will have a bunch of annoying merge conflicts.

Of course!

@yegeunyang
Copy link
Contributor

@rustbot release-assignment

@lolbinarycat
Copy link
Contributor Author

additionally, there's several tests involving deref that could get moved to tests/rustdoc/deref.

@jusexton
Copy link
Contributor

jusexton commented Apr 11, 2025

Skimmed the rustdoc-ui tests and put together hopefully a more concrete list of files that fall under the scope of this issue. I wouldn't mind making the changes once #136400 is merged.

Lints
custom_code_classes_in_docs-warning3.rs
diagnostic-width.rs
include-str-bare-urls.rs
remap-path-prefix-lint.rs
unescaped_backticks.rs
unportable-markdown.rs
redundant-explicit-links-123677.rs

Intra doc
circular-intra-doc-link-48414.rs
disambiguator-endswith-named-suffix.rs

Deref
deref-generic.rs
ice-blanket-impl-56701.rs
recursive-deref-ice.rs

@lolbinarycat
Copy link
Contributor Author

@jusexton there's also bad-intra-doc.rs

@lolbinarycat
Copy link
Contributor Author

another: redundant-explicit-links-123677.rs

@jusexton
Copy link
Contributor

@jusexton there's also bad-intra-doc.rs

Wasn't able to find this file. This is located under /rust/tests/rustdoc-ui?

another: redundant-explicit-links-123677.rs

Good catch, added to the complete list.

@lolbinarycat
Copy link
Contributor Author

Wasn't able to find this file.

That's because I added it in a PR that hasn't been merged yet 🤦

It's been so long since I started the PR I convinced myself it was an existing file I just added to.

I can just fix that one myself.

@lolbinarycat
Copy link
Contributor Author

another one: tests/rustdoc-ui/disambiguator-endswith-named-suffix.rs.

@Evalir
Copy link

Evalir commented May 11, 2025

@rustbot claim

@Evalir
Copy link

Evalir commented May 13, 2025

waiting on #136400

@lolbinarycat
Copy link
Contributor Author

@Evalir PR is merged!

@Evalir
Copy link

Evalir commented May 24, 2025

awesome thank you for the ping! i'll get to this soon!

@lolbinarycat
Copy link
Contributor Author

Found another one: rustdoc/duplicate-cfg.rs could be moved into the doc-cfg subdir.

@lolbinarycat
Copy link
Contributor Author

Feel free to split this up into several smaller PRs if you want, it should be less likely to get hit with multiple merge conflicts that way.

@lolbinarycat lolbinarycat added E-tedious Call for participation: An issue involves lots of work and is better handled as many small tasks. and removed E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Jun 5, 2025
@lolbinarycat lolbinarycat changed the title move tests from tests/rustdoc-ui/ to tests/rustdoc-ui/lints/ where applicable Tracking issue for moving rustdoc* tests to appropriate subdirs Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-technical-debt Area: Internal cleanup work A-testsuite Area: The testsuite used to check the correctness of rustc C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-tedious Call for participation: An issue involves lots of work and is better handled as many small tasks. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

6 participants