Add MYPYPATH To Stubtest Documentation #8868
Conversation
MYPYPATH must be set to the stub directory when running subtest on third party packages, otherwise the stubs won't be found. This is already done in scripts, but not mentioned in the relevant documentation. Signed-off-by: Hassan Abouelela <[email protected]>
|
This PR conflicts a little with #8822. Not sure how we want to resolve that. |
|
Ah I should've done a better job looking at existing PRs. If this section is removed anyway, I'm happy to just close this PR. I do hope some mention of it is kept, as it is still convenient to run stubtest with other options (such as concise), which isn't as easy with the script. However, toggling the ignore in metadata is something I wasn't aware of and is a good substitute. |
That's very fair! (I'm also very happy for this PR to be merged before mine btw.) Maybe, as Shantanu suggests, we should keep the example (with your revisions) and move it down to the section on |
|
Let's merge #8822 first and once it's merged, move the example down like Alex suggests :-) |
|
Okay @HassanAbouelela , just merged the other PR! |
# Conflicts: # tests/README.md
Move the instructions for manually running stubtest on third party packages to the correct section. Signed-off-by: Hassan Abouelela <[email protected]>
|
Thanks, I've merged in the other changes now |
Add missing information about the required setup for running subtest manually. Co-authored-by: Alex Waygood <[email protected]>
MYPYPATH must be set to the stub directory when running subtest on third party packages, otherwise the stubs won't be found. This is already done in scripts, but not mentioned in the relevant documentation.