Skip to content

Update testing framework documentation - #5446

Merged
pllim merged 3 commits into
astropy:masterfrom
josePhoenix:pytest-docs
Nov 17, 2016
Merged

pllim merged 3 commits into
astropy:masterfrom
josePhoenix:pytest-docs

Conversation

@josePhoenix

Copy link
Copy Markdown
Contributor
  • Make it consistent with the behavior of the test suite by eliminating the discussion of how to run the tests with py.test.
  • Make it consistent with the pytest project by using the new spelling of their name.
  • Minor grammar edits.

Joseph Long added 2 commits November 1, 2016 13:58
  - Rename `py.test` to `pytest` where ever it appears
  - Add example showing the `--args` argument to pass arguments
    to pytest
  - Remove discussion of running `pytest` directly

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks. You need to fix Sphinx error Unknown target name: "pytest". for the document to compile properly.

through with the ``--args`` argument::

.. note::
> python setup.py test --args "-x"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Pretty sure it is --args="-x" (with equal sign), as that is what I use in my own package. Also, you can pass in multiple options using --args='-x --y="xyz"', if you want to make the document even more detailed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Either one is valid, actually.

@josePhoenix

Copy link
Copy Markdown
Contributor Author

My find-and-replace missed a spot. Should be fixed now!

@pllim

pllim commented Nov 2, 2016

Copy link
Copy Markdown
Member

Looks good to me. Thanks! I'll leave this open for now in case others want to review.

@pllim pllim added this to the v1.3.0 milestone Nov 2, 2016
@pllim

pllim commented Nov 2, 2016

Copy link
Copy Markdown
Member

p.s. I'll just tag this as 1.3 since its release is coming up anyway, but feel free to re-milestone if needed.

@eteq

eteq commented Nov 2, 2016

Copy link
Copy Markdown
Member

This looks good to me.

For a bit more background, this came out of the efforts in #5435, which make it look like it may be very difficult to make the py.test-style invokation work as it used to. So the intent here is to remove that from the docs at least until we can get it working again (which may be never...)

@astrofrog or @bsipocz, do you have any thoughts on this (and maybe @embray depending on how much he's watching his notifications)? I.e., do you see push-back to just saying directly invoking py.test isn't supported right now?

@pllim

pllim commented Nov 17, 2016

Copy link
Copy Markdown
Member

I haven't seen any objections in 2 weeks, so merging.

@pllim
pllim merged commit 3a782f5 into astropy:master Nov 17, 2016
@bsipocz

bsipocz commented Nov 17, 2016 •

Copy link
Copy Markdown
Member

@eteq - It seems I never noticed this notification. Anyway it looks to be a good improvement, and I don't see much problems with the removal of direct py.test support (that isn't working anyway and should have a small enough priority to get fixed any time soon).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants