Skip to content

DOC: Update xdist to provide more speed-up options and context (#48958) (#48535) #48984

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

Merged
merged 5 commits into from
Oct 14, 2022

Conversation

noatamir
Copy link
Member

@noatamir noatamir commented Oct 7, 2022

👋 I was working on a more elaborate solution to the question in #48535 when @mroeschke made #48958 and closed it. So I tried to incorporate his work into mine to see if you are still interested in a more verbose solution. Things that might be interesting here are:

  • mentioning that pytest-xdist is in our environment and doesn't need to be installed
  • explaining the other speed up options which were available in the original script
  • explaining the -r summary flag and stating it's optional
  • showing people how to set a seed on Windows and Unix machines in case they need help (this might be redundant, I wasn't sure).

Screenshot for illustration:
Screenshot 2022-10-07 at 10 36 41

Please don't hesitate to close this if it's overkill at this point.

Copy link
Member

@phofl phofl left a comment

Choose a reason for hiding this comment

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

I like the clarifications, couple of these things weren't clear to me either when getting started with pandas

@mroeschke mroeschke added the Docs label Oct 7, 2022
@mroeschke
Copy link
Member

When demonstrating skipping tests, could we promote using e.g. -m "not slow" instead of --skip-slow? I think using -m "not ..." will be more flexible/scalable in the instance where we add more marks in the future and accomplishes the same test skipping.

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

I think this is a nice addition (it's certainly good to document how to use the markers)

@mroeschke mroeschke added this to the 1.6 milestone Oct 12, 2022
@mroeschke mroeschke modified the milestones: 1.6, 2.0 Oct 13, 2022
@phofl phofl merged commit 4b124de into pandas-dev:main Oct 14, 2022
@phofl
Copy link
Member

phofl commented Oct 14, 2022

thx @noatamir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants