Fix typos and improve the documentation #19763
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
|
@jonatack we don't consider test names documentation. Could you remove the |
jonatack
force-pushed
the
fix-typos-in-docs
branch
from
f5e1ee7
to
aa5bea2
Compare
|
@senny thanks for reviewing! Updated. |
|
@jonatack one more thing, we try to hard wrap our guides at around 80 chars. As we are not going to change them all at once it would be nice if you can wrap the paragraphs that have changes anyway. This way we are not messing up the git history and migrate the guides slowly towards our goal. |
|
@jonatack I think so, you can render the guides locally to verify. |
jonatack
force-pushed
the
fix-typos-in-docs
branch
from
dfe8fbe
to
f4414f5
Compare
|
You're right, rendering the guide locally with the TIP section line-wrapped looked the same. The generated HTML: Updated and squashed. |
This is a squash of the following commits, from first to last: - Fix minor, random things I’ve come across lately that individually did not seem worth making a PR for, so I saved them for one commit. One common error is using “it’s” (which is an abbreviation of “it is”) when the possessive “its” should be used for indicating possession. - Changes include the name of a test, so remove the `[skip ci]` (thanks @senny). - Line wrap the changes at 80 chars and add one more doc fix. - Add a missing line wrap in the Contributing to Ruby on Rails Guide. - Line wrap the `TIP` section in the Contributing to Ruby on Rails Guide as well. Rendering the guide locally with `bundle exec rake guides:generate` did not show any change in on-screen formatting after adding the line wrap. The HTML generated is (extra line added to illustrate where the line wrap takes place): <div class="info"><p>Please squash your commits into a single commit when appropriate. This simplifies future cherry picks and also keeps the git log clean.</p></div> - Squash commits.
jonatack
force-pushed
the
fix-typos-in-docs
branch
from
5df0082
to
6345f31
Compare
jonatack
changed the title
senny
added a commit
that referenced
this pull request
Apr 15, 2015
Fix typos and improve the documentation
|
@jonatack great work! 💛 |
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.
Mostly minor, random things I’ve come across lately that individually
did not seem worth making a PR for, so I saved them up for one commit.
One common error is using “it’s” (which is an abbreviation of “it is”)
when the possessive “its” should be used for indicating possession.