Skip to content
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.

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

Stop suggesting the single-threaded variant for running tests #7683

Closed
pradyunsg opened this issue Feb 2, 2020 · 1 comment · Fixed by #7878
Closed

Stop suggesting the single-threaded variant for running tests #7683

pradyunsg opened this issue Feb 2, 2020 · 1 comment · Fixed by #7878
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

Comments

@pradyunsg
Copy link
Member

pradyunsg commented Feb 2, 2020

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.

@pradyunsg pradyunsg added type: docs Documentation related good first issue A good item for first time contributors to work on labels Feb 2, 2020
@KoundinyaSi
Copy link

Hey!
I would like to work on this.

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Apr 25, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Apr 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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
Projects
None yet
2 participants