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

Updated getting_started.md guide source text to reflect the change in error message … #25952

Merged
merged 1 commit into from
Jul 28, 2016

Conversation

harfangk
Copy link

Summary

This is a simple update to the source text for Getting Started portion of the Rails Guide. When the guide discusses the error message in ActionController::UnknownFormat in Articles#new, the error message and explanation text do not match. I guess this is because the error message got updated in Rails 4, but explanation was not.

I removed the discussion about hash in the error message because the hash is no longer included in the error message, and added description about formats.variants. I also made some minor changes to paragraph structure to make it sound natural after the change.

…for ActionController::UnknownFromat in ArticlesController#new

`builder` or `coffee`. `:erb` is most commonly used for HTML templates, `:builder` is
used for XML templates, and `:coffee` uses CoffeeScript to build JavaScript templates.
Because you want to create a new HTML form, you will be
using the `ERB` language which is designed to embed Ruby in HTML.

Choose a reason for hiding this comment

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

Lets keep this information as it is useful. Can you change the wording as you did below but keep this info?

@prathamesh-sonpatki
Copy link
Member

@harfangk Thanks! Good find. Can you squash the commits and add [ci skip] to the commit message, so that travis won't run tests for this PR as this is only doc change. Also I posted a comment. 👍

@harfangk
Copy link
Author

I've restored explanations on handlers for XML and JS templates. That's what you meant, right? But then it seems I made a mess while trying to squash the commits - let me know if I can do something to clean it up.

@prathamesh-sonpatki
Copy link
Member

@harfangk Thanks, this looks good. Can you squash all 5 commits into one? We don't need those merge commits 😄

You can check http://blog.steveklabnik.com/posts/2012-11-08-how-to-squash-commits-in-a-github-pull-request for more details about squashing.

…for ActionController::UnknownFromat in ArticlesController#new

Restored texts about XML and JS template handlers. [ci skip]
@harfangk
Copy link
Author

Done and done! Thank you for pointing me to that article!

@prathamesh-sonpatki prathamesh-sonpatki merged commit 303353f into rails:master Jul 28, 2016
@prathamesh-sonpatki
Copy link
Member

Thanks @harfangk!

@rafaelfranca Please backport this to 5-0-stable.

rafaelfranca pushed a commit that referenced this pull request Jul 28, 2016
Updated getting_started.md guide source text to reflect the change in error message …
@rafaelfranca
Copy link
Member

Backported in added59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants