From d6ccdfc53d266e1f6b329069722c106775120181 Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Wed, 22 Oct 2014 16:43:37 +0200 Subject: [PATCH] Added Note on tox & .pyc files. Fixes #1957 --- CONTRIBUTING.md | 9 +++++++++ docs/topics/contributing.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6dd05a0e..6abc65534 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,6 +71,15 @@ You can also use the excellent [`tox`][tox] testing tool to run the tests agains tox +--- + +**Note**: If you run `tox` followed by `./runtests.py` you _may_ encounter a "bad marshall data" error as `pytest` attempts to read `.pyc` files from an incompatible Python version. To clear the offending `.pyc` files run: + + $ find . -name '*.pyc' -delete + +--- + + ## Pull requests It's a good idea to make pull requests early on. A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission. diff --git a/docs/topics/contributing.md b/docs/topics/contributing.md index 4fafb1b1e..8be753f2b 100644 --- a/docs/topics/contributing.md +++ b/docs/topics/contributing.md @@ -105,6 +105,15 @@ You can also use the excellent [tox][tox] testing tool to run the tests against tox +--- + +**Note**: If you run `tox` followed by `./runtests.py` you _may_ encounter a "bad marshall data" error as `pytest` attempts to read `.pyc` files from an incompatible Python version. To clear the offending `.pyc` files run: + + $ find . -name '*.pyc' -delete + +--- + + ## Pull requests It's a good idea to make pull requests early on. A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.