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

jsondocck: Use correct index for error message. #127287

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

aDotInTheVoid
Copy link
Member

If you misused a count command like @count $some.selector '"T'", you would panic with OOB:

thread 'main' panicked at src/tools/jsondocck/src/main.rs:76:92:
index out of bounds: the len is 2 but the index is 2

This is because 57c85bd removed the file param, but didn't update the error case. We now error with:

Invalid command: Second argument to @count must be a valid usize (got `"T"`) on line 20

As some point I want to rewrite this code to avoid indexing in general, but this is a nice small fix.

r? @GuillaumeGomez

If you misused a count command like `@count $some.selector '"T'"`, you would panic with OOB:

```
thread 'main' panicked at src/tools/jsondocck/src/main.rs:76:92:
index out of bounds: the len is 2 but the index is 2
```

Fixing this typo, we now get.

```
Invalid command: Second argument to @count must be a valid usize (got `"T"`) on line 20
```

As some point I want to rewrite this code to avoid indexing in general, but this is a nice small fix.
@rustbot rustbot added A-rustdoc-json Area: Rustdoc JSON backend 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 Jul 3, 2024
@GuillaumeGomez
Copy link
Member

Thanks! r=me once CI pass

@aDotInTheVoid
Copy link
Member Author

@bors r=GuillaumeGomez rollup

@bors
Copy link
Contributor

bors commented Jul 3, 2024

📌 Commit ccc8baf has been approved by GuillaumeGomez

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 Jul 3, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 4, 2024
Rollup of 5 pull requests

Successful merges:

 - rust-lang#126792 (wasm64 build with target-feature=+simd128,+atomics)
 - rust-lang#127195 (Remove unqualified form import of io::Error in process_vxworks.rs and fallback on remove_dir_impl for vxworks)
 - rust-lang#127287 (jsondocck: Use correct index for error message.)
 - rust-lang#127289 (rustdoc-json: Better representation of lifetime bounds in where clauses.)
 - rust-lang#127303 (chore: remove repeat words)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 726b9b7 into rust-lang:master Jul 4, 2024
6 checks passed
@rustbot rustbot added this to the 1.81.0 milestone Jul 4, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jul 4, 2024
Rollup merge of rust-lang#127287 - aDotInTheVoid:jsondocck-index, r=GuillaumeGomez

jsondocck: Use correct index for error message.

If you misused a count command like ``@count` $some.selector '"T'"`, you would panic with OOB:

```
thread 'main' panicked at src/tools/jsondocck/src/main.rs:76:92:
index out of bounds: the len is 2 but the index is 2
```

This is because 57c85bd removed the file param, but didn't update the error case. We now error with:

```
Invalid command: Second argument to `@count` must be a valid usize (got `"T"`) on line 20
```

As some point I want to rewrite this code to avoid indexing in general, but this is a nice small fix.

r? `@GuillaumeGomez`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-json Area: Rustdoc JSON backend 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.

4 participants