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

Add tidy check to ensure that rustdoc GUI tests start with a small description #106888

Merged
merged 2 commits into from
Jan 16, 2023

Conversation

GuillaumeGomez
Copy link
Member

The first commit comes from #106865 to prevent CI to fail.

This PR adds a tidy check to enforce having a small description at the top of the GUI test. Although the format is made to be as easy as possible to read, it's not always obvious what a test is actually checking. I think enforcing this will make it easier for us to come back on these tests if needed.

r? @notriddle

@rustbot rustbot added A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 14, 2023
@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
Copy link
Member Author

Fixed fmt issue.

@notriddle
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 15, 2023

📌 Commit 5376670 has been approved by notriddle

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 15, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 15, 2023
…iaskrgr

Rollup of 5 pull requests

Successful merges:

 - rust-lang#106888 (Add tidy check to ensure that rustdoc GUI tests start with a small description)
 - rust-lang#106896 (suggest `is_empty` for collections when casting to `bool`)
 - rust-lang#106900 (Fix regression in `unused_braces` with macros)
 - rust-lang#106906 (remove redundant clones)
 - rust-lang#106909 (Only suggest adding type param if path being resolved was a type)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 72180b3 into rust-lang:master Jan 16, 2023
@rustbot rustbot added this to the 1.68.0 milestone Jan 16, 2023
@GuillaumeGomez GuillaumeGomez deleted the tidy-gui-test branch January 16, 2023 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants