-
Notifications
You must be signed in to change notification settings - Fork 9
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
JOSS Review: test suite #39
Comments
Thanks very much,
This makes sense. I assume the tests have to test the main entry point.
P.
…On Mon, Jun 13, 2022 at 1:37 PM Konrad Hinsen ***@***.***> wrote:
The repository contains a test suite (directory tests), but I have not
been able to find documentation for running the tests.
It isn't difficult to run the tests:
- install pygetpapers
- install pytest
- clone the pygetpapers repository
- run "pytest" at the top level of the repository
This is not quite standard, because a test suite should not require prior
installation, and the test suite should test the version of the code in the
repository, not an earlier version that happens to be installed.
Suggestion:
- If possible, modify the test suite to work like most users would
expect it to work. Then add documentation, which becomes "install pytest,
run pytest".
- If for some reason this cannot be done, document the process and
point out clearly that the test suite does not test the current state of
the source code repository.
—
Reply to this email directly, view it on GitHub
<#39>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAFTCS7P6ZGLS7CCXQNLZX3VO4TRHANCNFSM5YUCSEIQ>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
--
Peter Murray-Rust
Founder ContentMine.org
and
Reader Emeritus in Molecular Informatics
Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK
|
@khinsen Thanks very much for pointing this out. I have added instructions on how to run tests in the readme as well as make the system such that it runs the test on the version of pygetpapers in the current state of the source code repository. |
Great, thanks! This works fine now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The repository contains a test suite (directory
tests
), but I have not been able to find documentation for running the tests.It isn't difficult to run the tests:
pygetpapers
repositoryThis is not quite standard, because a test suite should not require prior installation, and the test suite should test the version of the code in the repository, not an earlier version that happens to be installed.
Suggestion:
The text was updated successfully, but these errors were encountered: