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

Make testing instructions less generic #1252

Merged
merged 1 commit into from Oct 16, 2019
Merged

Conversation

zackw
Copy link
Contributor

@zackw zackw commented Oct 16, 2019

In contributing.rst, the instructions for running tests locally appear to have been cut-and-pasted from the pytest manual, or something like that, and it's not clear exactly what to type. Replacing "project" with "trio" in two places fixes this. In particular, I have verified that pytest trio is the correct command to run the test suite once everything is set up.

Also use a code-block instead of a bulleted list of verbatim strings.

In `contributing.rst`, the instructions for running tests locally appear to have been cut-and-pasted from the pytest manual, or something like that, and it's not clear exactly what to type.  Replacing "project" with "trio" in two places fixes this.  In particular, I have verified that `pytest trio` is the correct command to run the test suite once everything is set up.

Also use a code-block instead of a bulleted list of verbatim strings.
@codecov
Copy link

codecov bot commented Oct 16, 2019

Codecov Report

Merging #1252 into master will increase coverage by 6.41%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1252      +/-   ##
==========================================
+ Coverage   93.16%   99.57%   +6.41%     
==========================================
  Files         106      106              
  Lines       12823    12823              
  Branches      984      984              
==========================================
+ Hits        11946    12768     +822     
+ Misses        826       35     -791     
+ Partials       51       20      -31
Impacted Files Coverage Δ
trio/tests/test_highlevel_socket.py 100% <0%> (+0.63%) ⬆️
trio/testing/_check_streams.py 99.33% <0%> (+0.66%) ⬆️
trio/_subprocess.py 100% <0%> (+0.7%) ⬆️
trio/_core/_run.py 99.72% <0%> (+0.94%) ⬆️
trio/_core/tests/test_ki.py 100% <0%> (+0.97%) ⬆️
trio/tests/test_testing.py 100% <0%> (+1.11%) ⬆️
trio/tests/test_unix_pipes.py 100% <0%> (+2.12%) ⬆️
trio/_highlevel_open_tcp_listeners.py 100% <0%> (+2.12%) ⬆️
trio/tests/test_highlevel_open_tcp_listeners.py 100% <0%> (+2.32%) ⬆️
trio/tests/test_socket.py 100% <0%> (+3.18%) ⬆️
... and 23 more

@zackw
Copy link
Contributor Author

zackw commented Oct 16, 2019

I don't understand how a commit that touches only the documentation could possibly have caused code coverage changes :-(

@pquentin
Copy link
Member

We use codecov to merge coverage reports across platforms, and it's not 100% reliable. Sometimes we miss a platform or two in a commit, so the coverage drops, only to raise again in the next PR. That's unfortunate but there's no easy way to do better than this.

Anyway, thank you for your contribution!

@pquentin pquentin merged commit d618d47 into python-trio:master Oct 16, 2019
@trio-bot
Copy link

trio-bot bot commented Oct 16, 2019

Hey @zackw, it looks like that was the first time we merged one of your PRs! Thanks so much! 🎉 🎂

If you want to keep contributing, we'd love to have you. So, I just sent you an invitation to join the python-trio organization on Github! If you accept, then here's what will happen:

  • Github will automatically subscribe you to notifications on all our repositories. (But you can unsubscribe again if you don't want the spam.)

  • You'll be able to help us manage issues (add labels, close them, etc.)

  • You'll be able to review and merge other people's pull requests

  • You'll get a [member] badge next to your name when participating in the Trio repos, and you'll have the option of adding your name to our member's page and putting our icon on your Github profile (details)

If you want to read more, here's the relevant section in our contributing guide.

Alternatively, you're free to decline or ignore the invitation. You'll still be able to contribute as much or as little as you like, and I won't hassle you about joining again. But if you ever change your mind, just let us know and we'll send another invitation. We'd love to have you, but more importantly we want you to do whatever's best for you.

If you have any questions, well... I am just a humble Python script, so I probably can't help. But please do post a comment here, or in our chat, or on our forum, whatever's easiest, and someone will help you out!

@zackw zackw deleted the patch-1 branch October 16, 2019 19:41
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

Successfully merging this pull request may close these issues.

None yet

2 participants