Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve wording in getting started guide #31953

Merged

Conversation

jameslovejoy
Copy link
Contributor

Summary

  • Updates some awkward wording about updating an article object
  • Adds missing Oxford commas
  • Updates several URLs to https
  • Upcase "CSS"

@rails-bot
Copy link

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @eileencodes (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

This option tells Rails that we want this form to be submitted
via the `PATCH` HTTP method which is the HTTP method you're expected to use to
**update** resources according to the REST protocol.
Passing the `@article` object to the method will automatically set the URL for
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd prefer to keep "the article object" here -- it's the class that affects the URL, but mentioning the variable name here seems to risk implying it's relevant. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. After re-reading the rest of the guide, just the plain "article object" text makes sense here. The specific syntax of model: @article is described below anyway.

I'll revert it and push up a new commit.

@eileencodes eileencodes merged commit 81c7d41 into rails:master Feb 12, 2018
@jameslovejoy jameslovejoy deleted the improve-wording-getting-started branch February 12, 2018 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants