React readme cleanup #636
Merged
React readme cleanup #636
Conversation
This file contains hidden or 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
When I added this section in f2dc504 I didn't do a very good job of following the style used in other parts of this repo. This commit remedies that.
Collaborator
|
This all seems good to me |
I noticed a number of places in this document where code was being referenced but it was not marked as such. Adding backticks will instruct the markdown parser to format these bits as code, which should improve the readability of this document.
I noticed that this heading wasn't listed in the table of contents. Adding it will help people see at-a-glance what they might find in this document.
I noticed that some newlines and indentation were a little inconsistent in this file, so I decided to smooth things out a bit. This should help people who decide to modify this document in the future. When determining which is the "right" way to format these things, I decided to use the style used by base readme as a guide.
lencioni
force-pushed
the
react-readme-cleanup
branch
from
2143857 to
474087c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 I was poking around in this file today, I noticed a few very minor things that could use some attention. These commits mostly just adjust some of the formatting--some for the benefit of those reading the rendered markdown, and others for the benefit of those looking at the markdown source. There's likely still more that could be done, but I figured I'd throw this up here since I think it makes a few small improvements.