Skip to content

Commit c369c0d

Browse files
authored
docs: add a hint to install the rust-src component (#5721)
1 parent 64d6db0 commit c369c0d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Contributing.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,13 @@ Use `nox -l` to list the full set of subcommands you can run.
4747

4848
PyO3 uses [`trybuild`][trybuild] to develop UI tests to capture error messages from the Rust compiler for some of the macro functionality.
4949

50-
Because there are several feature combinations for these UI tests, when updating them all (e.g. for a new Rust compiler version) it may be helpful to use the `update-ui-tests` nox session:
50+
The Rust compiler's error output differs depending on whether the `rust-src` component is installed. PyO3's CI has `rust-src` installed, so you need it locally for your UI test output to match:
5151

52+
```bash
53+
rustup component add rust-src
54+
```
55+
56+
Because there are several feature combinations for these UI tests, when updating them all (e.g. for a new Rust compiler version) it may be helpful to use the `update-ui-tests` nox session:
5257
```bash
5358
nox -s update-ui-tests
5459
```

0 commit comments

Comments
 (0)