aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarlton Gibson2014-10-22 16:43:37 +0200
committerCarlton Gibson2014-10-22 16:43:37 +0200
commitd6ccdfc53d266e1f6b329069722c106775120181 (patch)
treebd4ecec1a50d25a3090a495ced33874e708d99a0
parent4ad4fca6cec66b8f088921404e6896ee0b324a03 (diff)
downloaddjango-rest-framework-d6ccdfc53d266e1f6b329069722c106775120181.tar.bz2
Added Note on tox & .pyc files. Fixes #1957
-rw-r--r--CONTRIBUTING.md9
-rw-r--r--docs/topics/contributing.md9
2 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a6dd05a0..6abc6553 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 4fafb1b1..8be753f2 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.