minor documentation improvements #254
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
While reading through the documentation, I found some words might look nicer if they are codified (i.e. by enclosing them by backticks), mainly: - make sure to codify `MethodInstance` - if a package module is actually used, codify its name, e.g. `SnoopCompile` Please tell me if you don't like these changes -- I don't mind simply reverting that part. Unrelated to above, I also added some typo fixes.
timholy
approved these changes
Aug 11, 2021
Codecov Report
@@ Coverage Diff @@
## master #254 +/- ##
=======================================
Coverage 85.06% 85.06%
=======================================
Files 9 9
Lines 1587 1587
=======================================
Hits 1350 1350
Misses 237 237 Continue to review full report at Codecov.
|
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.
While reading through the documentation, I found some words might look
nicer if they are codified (i.e. by enclosing them by backticks), mainly:
MethodInstanceSnoopCompilePlease tell me if you don't like these changes -- I don't mind simply
reverting that part.
Unrelated to above changes, I also added some typo fixes.