-
-
Notifications
You must be signed in to change notification settings - Fork 143
update docs #162
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 docs #162
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small change suggested
docs/tests.md
Outdated
|
||
- Run all local tests: </br> `poe test_all` </br> </br> | ||
- Run all tests (includes installing the stubs): `poe test_all` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should say "includes testing the stubs when installed"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
test_all
installes the stubs, then tests them, and then uninstalled them
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, but the remark seems to indicate that it is just installing the stubs. So that's why I suggested the change.
How about "includes testing stubs as installed"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I merged main and slightly modified the existing description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @twoertwein
updated tests.md, style.md is already covered in tests.md, and removed html formatting tags.