Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Fixed markup in Upgrading RoR guide #7502

Merged
merged 1 commit into from

4 participants

@xoen

Hi everybody, I've changed a bit a couple of lines in the Upgrading Ruby on Rails guide:

  • Using syntax for unicode character routes example instead of <tt> since it causes single quotes to be transformed into inverted commas. This makes this required change more eye-catching.
  • Using <tt> for the j alias and related helpers as written in the documentation guidelines.

In particular the second point is the reason for a PR instead of a push in the docrails guide, in the current version of the guide inverted commas are used for code, maybe there was a reason for that (e.g. "j" is very short)?

PS: The guide isn't valid because another markup issue that I've already fixed in docrails: rails/docrails@70d2d2c

@xoen xoen Fixed markup in Upgrading RoR guide [ci skip]
There are two changes:
- Using <ruby> syntax for unicode character routes example instead of
  <tt> since it causes single quotes to be transformed into inverted
  commas. This makes this required change more eye-catching.
- Using <tt> for the j alias and related helpers as written in the
  documentation guidelines.
593fa0b
@arunagw
Collaborator

How about doing this in docrails ?

@xoen

Hi, well I've made a PR instead of pushing directly in docrails because I wasn't sure if rafaelfranca used the inverted commas for code for a reason. Looking at the commit it seems it's just the MD code taken from the CHANGELOG entry...

@carlosantoniodasilva

@xoen thanks, I think the changes look ok. You're right about the backtick thing, they're supposed to be used as tt.

I've added a comment on the docrails commit that you linked above, please take a look, and I'm merging this one. Thanks again.

@carlosantoniodasilva carlosantoniodasilva merged commit ebc50c5 into rails:master
@arunagw
Collaborator

Cool :-)

@xoen

Thanks :)

PS: I've fixed the issue related to underscore using the HTML entity for it, I hope it's OK.

@rafaelfranca
Owner

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Sep 2, 2012
  1. @xoen

    Fixed markup in Upgrading RoR guide [ci skip]

    xoen authored
    There are two changes:
    - Using <ruby> syntax for unicode character routes example instead of
      <tt> since it causes single quotes to be transformed into inverted
      commas. This makes this required change more eye-catching.
    - Using <tt> for the j alias and related helpers as written in the
      documentation guidelines.
This page is out of date. Refresh to see the latest.
Showing with 12 additions and 2 deletions.
  1. +12 −2 guides/source/upgrading_ruby_on_rails.textile
View
14 guides/source/upgrading_ruby_on_rails.textile
@@ -54,11 +54,21 @@ h4(#action_pack4_0). Action Pack
Rails 4.0 changed how <tt>assert_generates</tt>, <tt>assert_recognizes</tt>, and <tt>assert_routing</tt> work. Now all these assertions raise <tt>Assertion</tt> instead of <tt>ActionController::RoutingError</tt>.
-Rails 4.0 also changed the way unicode character routes are drawn. Now you can draw unicode character routes directly. If you already draw such routes, you must change them, e.g. <tt>get Rack::Utils.escape('こんにちは'), :controller => 'welcome', :action => 'index'</tt> to <tt>get 'こんにちは', :controller => 'welcome', :action => 'index'</tt>.
+Rails 4.0 also changed the way unicode character routes are drawn. Now you can draw unicode character routes directly. If you already draw such routes, you must change them, for example:
+
+<ruby>
+get Rack::Utils.escape('こんにちは'), :controller => 'welcome', :action => 'index'
+</ruby>
+
+becomes
+
+<ruby>
+get 'こんにちは', :controller => 'welcome', :action => 'index'
+</ruby>
h4(#active_support4_0). Active Support
-Rails 4.0 Removed the `j` alias for `ERB::Util#json_escape` since `j` is already used for `ActionView::Helpers::JavaScriptHelper#escape_javascript`.
+Rails 4.0 Removed the <tt>j</tt> alias for <tt>ERB::Util#json_escape</tt> since <tt>j</tt> is already used for <tt>ActionView::Helpers::JavaScriptHelper#escape_javascript</tt>.
h4(#helpers_order). Helpers Loading Order
Something went wrong with that request. Please try again.