Skip to content

DOC: Update contributing for test_fast, fix doc Windows build #15523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 27, 2017
+25 −11
Merged

DOC: Update contributing for test_fast, fix doc Windows build #15523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e8f6de
DOC: Update contributing for test_fast, fix doc Windows build
Dr-Irv Feb 27, 2017
4f02d36
add pip install for xdist
Dr-Irv Feb 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/make.py
View file
Open in desktop
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
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add that you will need to pip install pytest-xdist

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jreback OK, just pushed that commit. You probably can kill some of the travis/circleCI/appveyor stuff since there is no code to test here.

Maybe one day pytest-xdist will be available via a standard conda install!

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
View file
Open in desktop
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