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

Update testing instructions #16

Closed
3 tasks done
arjunsavel opened this issue Aug 19, 2021 · 2 comments
Closed
3 tasks done

Update testing instructions #16

arjunsavel opened this issue Aug 19, 2021 · 2 comments

Comments

@arjunsavel
Copy link

arjunsavel commented Aug 19, 2021

I was able to execute the tests for this project without difficulty — nicely done! I did have a few broad testing-related comments:

  • Lots of warnings (1671) were generated for me while running the tests. Many were the same (VerifyWarning). If this error can’t be worked around, I’d recommend suppressing it or explicitly mentioning to the user that these are expected in the documentation. Furthermore, single RuntimeWarning was generated in test_quicklook_blue, which should perhaps be investigated. Nitpick for some of the other warnings: np.float —> float, np.bool —> bool, np.int —> int. I also noted a UserWarning about "bad entries." [On a subsequent look, it seems as though many of these warnings are thrown because of PypeIt (I got 478 warnings just from running the PypeIt test suite) — in which case a mention in your documentation should suffice]
  • I'd point people explicitly to running PypeIt's test suite.
  • It might be worth mentioning in the documentation how long you expect the tests to take. On my machine, the tests took ~6 minutes — which is fine, but if a user is expecting a snappy runtime, they might worry that something's wrong!

This issue is part of my JOSS review.

@finagle29
Copy link
Owner

I think I addressed all of these in #23.

@arjunsavel
Copy link
Author

Great, thanks!

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

No branches or pull requests

2 participants