README.md: better document test_stubtest pitfall (#3793)

Document that the test will likely fail locally, to help cases like #3782
This commit is contained in:
Shantanu
2020-02-29 04:58:47 -08:00
committed by GitHub
parent d53977221a
commit aa6e3efcca
2 changed files with 11 additions and 6 deletions

View File

@@ -44,8 +44,8 @@ def run_stubtest(typeshed_dir: Path) -> int:
subprocess.run(cmd, check=True)
except subprocess.CalledProcessError as e:
print(
"\nNB: stubtest output depends on the Python version it is run with. See README.md "
"for more details.\n"
"\nNB: stubtest output depends on the Python version (and system) it is run with. "
"See README.md for more details.\n"
"NB: We only check positional-only arg accuracy for Python 3.8.\n"
"If stubtest is complaining about 'unused whitelist entry' after your fix, please "
"remove the entry from the whitelist file. Note you may have to do this for other "