Skip to content

Commit

Permalink
DOC: Update contributing for test_fast, fix doc Windows build (pandas…
Browse files Browse the repository at this point in the history
…-dev#15523)

* DOC: Update contributing for test_fast, fix doc Windows build

* add pip install for xdist
  • Loading branch information
Dr-Irv authored and jorisvandenbossche committed Feb 27, 2017
1 parent 61fa8be commit e0647ba
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 11 deletions.
4 changes: 2 additions & 2 deletions doc/make.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ def html():
raise SystemExit("Building HTML failed.")
try:
# remove stale file
os.system('rm source/html-styling.html')
os.system('cd build; rm -f html/pandas.zip;')
os.remove('source/html-styling.html')
os.remove('build/html/pandas.zip')
except:
pass

Expand Down
29 changes: 20 additions & 9 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -520,15 +520,6 @@ submitting code to run the check yourself on the diff::

git diff master | flake8 --diff

Furthermore, we've written a tool to check that your commits are PEP8 great, `pip install pep8radius
<https://github.com/hayd/pep8radius>`_. Look at PEP8 fixes in your branch vs master with::

pep8radius master --diff

and make these changes with::

pep8radius master --diff --in-place

Backwards Compatibility
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -611,6 +602,26 @@ Or with one of the following constructs::
pytest pandas/tests/[test-module].py::[TestClass]
pytest pandas/tests/[test-module].py::[TestClass]::[test_method]

Using `pytest-xdist <https://pypi.python.org/pypi/pytest-xdist>`_, one can
speed up local testing on multicore machines. To use this feature, you will
need to install `pytest-xdist` via::

pip install pytest-xdist
Two scripts are provided to assist with this. These scripts distribute
testing across 4 threads.

On Unix variants, one can type::

test_fast.sh
On Windows, one can type::

test_fast.bat
This can significantly reduce the time it takes to locally run tests before
submitting a pull request.

For more, see the `pytest <http://doc.pytest.org/en/latest/>`_ documentation.

.. versionadded:: 0.20.0
Expand Down
3 changes: 3 additions & 0 deletions test_fast.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:: test on windows
set PYTHONHASHSEED=314159265
pytest --skip-slow --skip-network -m "not single" -n 4 pandas

0 comments on commit e0647ba

Please sign in to comment.