Stop suggesting the single-threaded variant for running tests #7683
Labels
auto-locked
Outdated issues that have been locked by automation
good first issue
A good item for first time contributors to work on
type: docs
Documentation related
Currently, the first suggestion in our Getting Started guide, for running tests is
tox -e py36
. This is sub-optimal since contributors run this command directly, without looking at the suggestion immediately after to run the tests in parallel. This can end up taking a lot of time, which isn't ideal for time-constrained events like development sprints and isn't a great contribution experience either.It would be a good idea to move the
tox -e py36 -- -n auto
suggestion, to be first, rephrasing the sentences to more clearly indicate that it is preferable to run tests in parallel when running multiple tests.Relevant file:
docs/html/development/getting-started.rst
Relevant documentation (built): https://pip.pypa.io/en/latest/development/getting-started/#running-tests
Good First Issue: This issue is a good starting point for first time contributors -- the process of fixing this should be a good introduction to pip's development workflow. If you've already contributed to pip, work on another issue without this label instead. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our Getting Started Guide. If you are working on this issue and have questions, feel free to ask them here,
#pypa-dev
on Freenode, or the pypa-dev mailing list.The text was updated successfully, but these errors were encountered: