Alcampopiano / hypothesize

Robust statistics in Python
https://alcampopiano.github.io/hypothesize/
BSD 3-Clause "New" or "Revised" License
62 stars 3 forks source link

Provide documentation and dependencies for running tests #8

Closed arbennett closed 4 years ago

arbennett commented 4 years ago

The contributing documentation describes how tests are structured and tools used, but doesn't actually say how to run the tests. I think adding a sentence or two describing how to run the tests would be useful. Perhaps something like:

Following installation, to run the test suite first navigate to the tests directory then use the pytest command.

Additionally, in the setup.py it would be useful to add tests_require=['pytest'] for completeness.

Alcampopiano commented 4 years ago

Hello @arbennett,

Thank you for this suggestion. I have added the following sentence as suggested:

To run the test suite, first navigate to the "tests" directory then use the pytest command from your terminal.

I have also added tests_require=['pytest'] to the setup file. Thank you for that helpful suggestion.

I will close this issue but feel free to reopen if I have not fully addressed the issue.