Rephrase instructions for local usage #327
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The rewords some of the instructions in the README for local coverage measurement. The major changes & their motivations are: - indicate the purpose of each step before describing the mechanics of the step. This also makes it easier to indicate that one does not necessarily need to measure summary statistics if one's only goal is to find lines lacking coverage. - prioritize `Pkg.test(; coverage=true)` above manual measurement. Most users will want the simpler option. - clarify the role of the `.info` tracefile. This allows users to determine when they need to supply the more complex set of options. By presenting it as a choice it also makes it clearer that you don't need to execute both lines. - acknowledge limitations in the accuracy of Julia's coverage analysis
Pull Request Test Coverage Report for Build 1345843085
💛 - Coveralls |
Codecov Report
@@ Coverage Diff @@
## master #327 +/- ##
==========================================
+ Coverage 90.09% 90.56% +0.47%
==========================================
Files 2 2
Lines 212 212
==========================================
+ Hits 191 192 +1
+ Misses 21 20 -1
Continue to review full report at Codecov.
|
|
This is for a class I'm teaching, and the homework gets assigned today, so I'll merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The rewords some of the instructions in the README for local coverage measurement. The major changes & their motivations are:
Pkg.test(; coverage=true)above manual measurement. Most users will want the simpler option..infotracefile. This allows users to determine when they need to supply the more complex set of options. By presenting it as a choice it also makes it clearer that you don't need to execute both lines.