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

clarify README #134

Merged
merged 1 commit into from
Nov 21, 2024
Merged

clarify README #134

merged 1 commit into from
Nov 21, 2024

Conversation

sywhang
Copy link
Contributor

@sywhang sywhang commented Nov 21, 2024

someone at Uber unfortunately spent cycles trying to convert VerifyTestMain call to VerifyNone(t) for individual cases only to find out that it doesn't work well with t.Parallel().

Even though VerifyNone(t)'s documentation already says this, it might be worth clarifying this in the README since the wording can make it sound like calling VerifyTestMain() vs calling VerifyNone() at the end of every single test case is completely identical in behavior.

someone at Uber unfortunately spent cycles trying to convert
VerifyTestMain call to VerifyNone(t) for individual cases only to
find out that it doesn't work well with t.Parallel().

Even though VerifyNone(t)'s documentation already says this, it might
be worth clarifying this in the README since the wording can make it
sound like calling VerifyTestMain() vs calling VerifyNone() at the
end of every single test case is completely identical in behavior.
Copy link

codecov bot commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.57%. Comparing base (79b1d32) to head (cbaab95).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #134      +/-   ##
==========================================
- Coverage   99.20%   98.57%   -0.64%     
==========================================
  Files           5        5              
  Lines         252      351      +99     
==========================================
+ Hits          250      346      +96     
- Misses          1        4       +3     
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@sywhang sywhang requested a review from JacobOaks November 21, 2024 20:32
@sywhang sywhang merged commit 4ff5fa6 into uber-go:master Nov 21, 2024
6 of 7 checks passed
@sywhang sywhang deleted the readme-clarify branch November 21, 2024 20:38
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.

2 participants