TranslatorSRI / SRI_testing

MIT License
0 stars 1 forks source link

Update individual test commands and add to main README #87

Open gaurav opened 1 year ago

gaurav commented 1 year ago

The one-hop README contains instructions on running individual tests at https://github.com/TranslatorSRI/SRI_testing/tree/d034e836bca2c7116778abcb9bd356bb5e36cac6/tests/onehop#running-the-tests.

RichardBruskiewich commented 1 year ago

Hi @gaurav, I've taken a run at resolving your issue above, just now posted into the master branch as commit https://github.com/TranslatorSRI/SRI_testing/commit/e9adc4b92fdfa41c04f58cdc7a3c169cc43485f1. Please kindly remove the updated README.md file.

gaurav commented 1 year ago

Thanks, Richard! The updated README file looks good. Are you going to update the poetry run instructions in tests/onehop/README.md as well?

RichardBruskiewich commented 1 year ago

Thanks for the feedback.

The project was originally pip installed. The change to poetry does modify the required commands as you indicated. Sorry about the lag in docs. I'll fix this right away.

Thanks, Richard! The updated README file looks good. Are you going to update the poetry run instructions in tests/onehop/README.md as well?

AH yes.. good point! I'll do that in a few minutes... just putting out another technical fire...

RichardBruskiewich commented 1 year ago

OK, please see the master again. I've updated the OneHop detailed README now (plus a few refinements elsewhere).

@gaurav please kindly review the final revised documentation. I hope we've gotten there. If you think we have, please close the issue.

gaurav commented 1 year ago

This looks great! I have one minor suggestion: after saying "you would type the following from within the tests/onehop project subfolder:", I would change the example code to:

cd tests/onehop
pytest test_onehops.py

Just to make sure nobody misses that. Otherwise, the test commands I tried all worked for me! Feel free to close this issue once you've decided whether or not to incorporate my suggestion above.