Clarify and extend ReadMe to improve clarity #9
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
I've added an introduction to what Safely does and tweaked the test to improve clarity. One thing I'm not absolutely sure about is where you recommend the reporting service to be configured - I've suggested an initializer.
Clarify and extend ReadMe to improve clarity
|
Hey @JohnPettigrew, thanks for the PR! Agree it'd be good clarify where customization should go (in an initializer). Can you explain more about the other changes? |
|
Sure.
Thanks! |
|
Hey @JohnPettigrew, sorry for the delay (have been focused on other projects). I appreciate the suggestions, but prefer to keep the existing style. |
ankane
added a commit
that referenced
this pull request
Oct 7, 2020
|
I've added a note about the initializer in d47ce49. |
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.
I've added an introduction to what Safely does and tweaked the text to improve clarity. One thing I'm not absolutely sure about is where you recommend the reporting service to be configured - I've suggested an initializer.