From 1480f309c3d34b8089dc400d8ed0c535a8114423 Mon Sep 17 00:00:00 2001 From: Robert Nishihara Date: Sat, 12 Jan 2019 14:05:28 -0800 Subject: [PATCH] [doc] Replace runtest.py with mini_test.py in documentation. (#3750) Rename `xray_test.py` to `mini_test.py` and use that in the documentation. Right now we suggest that people run `runtest.py`, but that often doesn't succeed and takes too long. --- .travis.yml | 2 +- doc/source/development.rst | 2 +- doc/source/install-on-docker.rst | 2 +- doc/source/installation.rst | 3 +-- test/{xray_test.py => mini_test.py} | 0 5 files changed, 4 insertions(+), 5 deletions(-) rename test/{xray_test.py => mini_test.py} (100%) diff --git a/.travis.yml b/.travis.yml index 43da79dcd..59e5f408f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -157,7 +157,7 @@ script: - python -m pytest -v --durations=10 python/ray/test/test_global_state.py - python -m pytest -v --durations=10 python/ray/test/test_queue.py - python -m pytest -v --durations=10 python/ray/test/test_ray_init.py - - python -m pytest -v --durations=10 test/xray_test.py + - python -m pytest -v --durations=10 test/mini_test.py - python -m pytest -v --durations=10 test/runtest.py - python -m pytest -v --durations=10 test/array_test.py diff --git a/doc/source/development.rst b/doc/source/development.rst index dc1e53b2c..9b67ee01f 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -44,7 +44,7 @@ helpful. .. code-block:: shell cd ray - python test/runtest.py APITest.testKeywordArgs + python -m pytest -v test/runtest.py::test_keyword_args When running tests, usually only the first test failure matters. A single test failure often triggers the failure of subsequent tests in the same diff --git a/doc/source/install-on-docker.rst b/doc/source/install-on-docker.rst index 6baa0363f..e12121249 100644 --- a/doc/source/install-on-docker.rst +++ b/doc/source/install-on-docker.rst @@ -148,7 +148,7 @@ container shell enter the following commands: .. code-block:: bash - python test/runtest.py # This tests basic functionality. + python -m pytest -v test/mini_test.py # This tests some basic functionality. You are now ready to continue with the `tutorial`_. diff --git a/doc/source/installation.rst b/doc/source/installation.rst index daf9a8cf8..daf7d62ef 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -116,8 +116,7 @@ that you've cloned the git repository. .. code-block:: bash - export PYTHONPATH="$PYTHONPATH:./test/" - python -m pytest test/runtest.py + python -m pytest -v test/mini_test.py Cleaning the source tree ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/test/xray_test.py b/test/mini_test.py similarity index 100% rename from test/xray_test.py rename to test/mini_test.py