tidy: enforce comment blocks to have an even number of backticks #108726

est31 · 2023-03-04T05:38:57Z

After PR #108694, most unmatched backticks in compiler/ comments have been eliminated. This PR adds a tidy lint to ensure no new unmatched backticks are added, and either addresses the lint in the remaining instances it found, or allows it.

Very often, backtick containing sections wrap around lines, for example:

// This function takes a tuple `(Vec<String>,
// Box<[u8]>)` and transforms it into `Vec<u8>`.

The lint is implemented to work on top of blocks, counting each line with a // into a block, and counting if there are an odd or even number of backticks in the entire block, instead of looking at just a single line.

rustbot · 2023-03-04T05:39:03Z

r? @albertlarsan68

(rustbot has picked a reviewer for you, use r? to override)

rustbot · 2023-03-04T05:39:07Z

Some changes occurred to the core trait solver

cc @rust-lang/initiative-trait-system-refactor

est31 · 2023-03-04T05:39:13Z

r? @Nilstrieb

src/tools/tidy/src/style.rs

the8472 · 2023-03-04T13:03:41Z

Have you measured the runtime impact of this change? style.rs is one of the longer-running checks in tidy.

est31 · 2023-03-04T20:40:23Z

Have you measured the runtime impact of this change?

Doing it now, I don't really see much of an impact.

The three times I measured all of tidy before:

real    0m3,520s
user    0m5,624s
sys     0m2,584s

real    0m3,588s
user    0m5,664s
sys     0m2,478s

real    0m3,558s
user    0m5,778s
sys     0m2,557s

real    0m3,563s
user    0m5,697s
sys     0m2,591s

after:

real    0m3,548s
user    0m5,876s
sys     0m2,587s

real    0m3,549s
user    0m5,670s
sys     0m2,646s

real    0m3,984s
user    0m5,574s
sys     0m2,653s

real    0m3,588s
user    0m5,783s
sys     0m2,650s

That is, running time ./x test tidy, after having commented out the rustfmt invocation in src/bootstrap/test.rs.

est31 · 2023-03-08T00:06:56Z

Regarding the commit which adds checking to the ftl files, the lint would have told about the ftl string bugs that were (among non-ftl issues) fixed by ef65890 .

For the other tidy checks, they would have told about the odd backtick numbers in comments as fixed by #108694 and #108685.

compiler/rustc_hir_typeck/src/closure.rs

Noratrieb

r=me with or without removing the FIXME

(I guess technically T-bootstrap is in charge of tidy? But this is just for the compiler, seems fine to me. whatever.)

est31 · 2023-03-11T19:27:08Z

@Nilstrieb note that there is a second fixme, see the "add two fixmes" commit.

Noratrieb · 2023-03-11T19:35:53Z

the second one can just be deleted i guess, that comment isn't complete anyways.

Some comments may be formed like: // This function takes a tuple `(Vec<String>, // Box<[u8]>)` and transforms it into `Vec<u8>`. where the "back-ticked" section wraps around. Therefore, we can't make a single-line based lint. We also cannot make the lint paragraph based, as it would otherwise complain about inline code blocks: /// ``` /// use super::Foo; /// /// fn main() { Foo::new(); } /// ``` For the future, one could introduce some checks to treat code blocks specially, but such code would make the check even more complicated.

Co-authored-by: nils <48135649+Nilstrieb@users.noreply.github.com>

est31 · 2023-03-11T21:06:26Z

@Nilstrieb it should be ready now!

Noratrieb · 2023-03-11T21:50:17Z

@bors r+

bors · 2023-03-11T21:50:19Z

📌 Commit b2aeb07 has been approved by Nilstrieb

It is now in the queue for this repository.

…r=Nilstrieb tidy: enforce comment blocks to have an even number of backticks After PR rust-lang#108694, most unmatched backticks in `compiler/` comments have been eliminated. This PR adds a tidy lint to ensure no new unmatched backticks are added, and either addresses the lint in the remaining instances it found, or allows it. Very often, backtick containing sections wrap around lines, for example: ```Rust // This function takes a tuple `(Vec<String>, // Box<[u8]>)` and transforms it into `Vec<u8>`. ``` The lint is implemented to work on top of blocks, counting each line with a `//` into a block, and counting if there are an odd or even number of backticks in the entire block, instead of looking at just a single line.

…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#108726 (tidy: enforce comment blocks to have an even number of backticks) - rust-lang#108797 (Allow binary files to go through the `FileLoader`) - rust-lang#108841 (Add suggestion to diagnostic when user has array but trait wants slice. (rebased)) - rust-lang#108984 (bootstrap: document tidy) - rust-lang#109013 (Give proper error message when tcx wasn't passed to decoder) - rust-lang#109017 (remove duplicated calls to sort_string) - rust-lang#109018 (Expand on the allocator comment in `rustc-main`) - rust-lang#109028 (Add eslint checks for rustdoc-js tester) - rust-lang#109034 (Commit some tests for the new solver + lazy norm) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned albertlarsan68 Mar 4, 2023

rustbot assigned Noratrieb and unassigned albertlarsan68 Mar 4, 2023

est31 force-pushed the backticks_matchmaking_tidy branch from ac50e29 to 1af3b8c Compare March 4, 2023 06:02

the8472 reviewed Mar 4, 2023

View reviewed changes

src/tools/tidy/src/style.rs Outdated Show resolved Hide resolved

est31 force-pushed the backticks_matchmaking_tidy branch from 1af3b8c to 4612baf Compare March 4, 2023 20:41

Noratrieb reviewed Mar 11, 2023

View reviewed changes

compiler/rustc_hir_typeck/src/closure.rs Outdated Show resolved Hide resolved

Noratrieb approved these changes Mar 11, 2023

View reviewed changes

est31 force-pushed the backticks_matchmaking_tidy branch from ab70d3e to 4b04f76 Compare March 11, 2023 19:27

est31 and others added 6 commits March 11, 2023 20:40

tidy: allow direct format args capture in macro

cde0b16

Address the new odd backticks tidy lint in compiler/

7f4cc17

Add a fixme and address a more non trivial case

9475717

Co-authored-by: nils <48135649+Nilstrieb@users.noreply.github.com>

Extend the tidy lint to ftl files

3a20d52

Use trimmed instead of line for performance

b2aeb07

est31 force-pushed the backticks_matchmaking_tidy branch from 4b04f76 to b2aeb07 Compare March 11, 2023 21:07

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 Mar 11, 2023

This was referenced Mar 12, 2023

Rollup of 10 pull requests #109042

Closed

Rollup of 9 pull requests #109043

Merged

bors merged commit 9668ae5 into rust-lang:master Mar 12, 2023

rustbot added this to the 1.70.0 milestone Mar 12, 2023

lukas-code mentioned this pull request Apr 27, 2023

rustdoc: Add a new lint for broken inline code #105848

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tidy: enforce comment blocks to have an even number of backticks #108726

tidy: enforce comment blocks to have an even number of backticks #108726

est31 commented Mar 4, 2023

rustbot commented Mar 4, 2023

rustbot commented Mar 4, 2023

est31 commented Mar 4, 2023

the8472 commented Mar 4, 2023

est31 commented Mar 4, 2023

est31 commented Mar 8, 2023 •

edited

Loading

Noratrieb left a comment

est31 commented Mar 11, 2023

Noratrieb commented Mar 11, 2023

est31 commented Mar 11, 2023

Noratrieb commented Mar 11, 2023

bors commented Mar 11, 2023

tidy: enforce comment blocks to have an even number of backticks #108726

tidy: enforce comment blocks to have an even number of backticks #108726

Conversation

est31 commented Mar 4, 2023

rustbot commented Mar 4, 2023

rustbot commented Mar 4, 2023

est31 commented Mar 4, 2023

the8472 commented Mar 4, 2023

est31 commented Mar 4, 2023

est31 commented Mar 8, 2023 • edited Loading

Noratrieb left a comment

Choose a reason for hiding this comment

est31 commented Mar 11, 2023

Noratrieb commented Mar 11, 2023

est31 commented Mar 11, 2023

Noratrieb commented Mar 11, 2023

bors commented Mar 11, 2023

est31 commented Mar 8, 2023 •

edited

Loading