Update README.md #220
Open
Update README.md #220
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 previous README showed headers with hashtags appended to the left of the header. I think that they are typos and the idea was to use the features of markdown to present a well formatted README. Also, the commands were not annotated properly (considering the markdown standards), disabling the opportunity to use the features of the markdown parser of github to display a button to copy/paste easily at the sides of each command. The changes made address the problems mentioned above.
NeedSomeCoolUsername
approved these changes
Mar 29, 2023
There was a problem hiding this comment.
I recently created PR with similar improvements as I didn't know about this one. I'll close it and expect this PR to be merged @jimmysong as current README is not really well formatted.
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 previous README showed headers with hashtags appended to the left of the header.
I think that they are typos and the idea was to use the features of markdown to present a
well formatted README. Also, the commands were not annotated properly (considering the
markdown standards), disabling the opportunity to use the features of the markdown parser
of github to display a button to copy/paste easily at the right of each command.
The changes made address the problems mentioned above.