Refactor README #9
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
- move Acknowledgements into this file - align overall structure with our other open source projects like rubocop-cargosense - refactor text for consistency, clarity, and correctness Note that I don't think I meaningfully changed the meaning or intent behind anything and certainly didn't change the examples.
jgarber623
added
the
documentation-update
billylanchantin
requested changes
Jun 14, 2024
There was a problem hiding this comment.
Thank you so much! This looks great :)
My comments are mostly nits because the refactor read quite solidly to me. There's one substantive piece of feedback about the placement of the "Usage" section which I feel somewhat strongly about (though not overly -- I could be convinced). Happy to discuss.
Co-authored-by: Billy Lanchantin <[email protected]>
Co-authored-by: Billy Lanchantin <[email protected]>
Co-authored-by: Billy Lanchantin <[email protected]>
|
@billylanchantin All feedback has been addressed and I requested a re-review at your convenience. |
billylanchantin
requested changes
Jun 14, 2024
Co-authored-by: Billy Lanchantin <[email protected]>
Co-authored-by: Billy Lanchantin <[email protected]>
|
Additional feedback implemented and review re-requested! |
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.
This PR updates the README with an eye toward clarity, brevity, and consistency.
Notable changes include:
Note that I didn't meaningfully changed the meaning or intent behind anything and certainly didn't change the examples.