GitHub Sale: sign up for any paid plan this week and pay nothing until January 1, 2009!  [ hide ]

public
Fork of lifo/doc-rails
Description: Repository for improving Rails documentation
Homepage: http://www.rubyonrails.org
Clone URL: git://github.com/zmalltalker/doc-rails.git
Using <tt> instead of + on symbols, as RDoc doesn't seem to parse that 
properly.
leethal (author)
Fri Apr 04 01:21:30 -0700 2008
commit  82788580a93fe1236e60ad9860f44034967112b8
tree    e153b2b02dbd5d34623f58223aa53264a5668850
parent  4ed80f6328a4968f8556a25bcf73431ade12b82a
...
47
48
49
50
 
51
52
53
...
82
83
84
85
 
86
87
88
...
47
48
49
 
50
51
52
53
...
82
83
84
 
85
86
87
88
0
@@ -47,7 +47,7 @@ module ActionController
0
   # :controller maps to your controller name
0
   # :action maps to an action with your controllers
0
   #
0
- # Other names simply map to a parameter as in the case of +:id+.
0
+ # Other names simply map to a parameter as in the case of <tt>:id</tt>.
0
   #
0
   # == Route priority
0
   #
0
@@ -82,7 +82,7 @@ module ActionController
0
   # This sets up +blog+ as the default controller if no other is specified.
0
   # This means visiting '/' would invoke the blog controller.
0
   #
0
- # More formally, you can define defaults in a route with the +:defaults+ key.
0
+ # More formally, you can define defaults in a route with the <tt>:defaults</tt> key.
0
   #
0
   # map.connect ':controller/:action/:id', :action => 'show', :defaults => { :page => 'Dashboard' }
0
   #
...
86
87
88
89
 
90
91
92
...
86
87
88
 
89
90
91
92
0
@@ -86,7 +86,7 @@ module ActionView
0
       # of +options+. See the valid options in the documentation for
0
       # url_for. It's also possible to pass a string instead
0
       # of an options hash to get a link tag that uses the value of the string as the
0
- # href for the link, or use +:back+ to link to the referrer - a JavaScript back
0
+ # href for the link, or use <tt>:back</tt> to link to the referrer - a JavaScript back
0
       # link will be used in place of a referrer if none exists. If nil is passed as
0
       # a name, the link itself will become the name.
0
       #
...
161
162
163
164
 
165
166
167
168
169
 
 
170
171
172
...
161
162
163
 
164
165
166
167
 
 
168
169
170
171
172
0
@@ -161,12 +161,12 @@ module ActiveRecord
0
       # an Array of Symbols.
0
       #
0
       # The index will be named after the table and the first column name,
0
- # unless you pass +:name+ as an option.
0
+ # unless you pass <tt>:name</tt> as an option.
0
       #
0
       # When creating an index on multiple columns, the first column is used as a name
0
       # for the index. For example, when you specify an index on two columns
0
- # [+:first+, +:last+], the DBMS creates an index for both columns as well as an
0
- # index for the first column +:first+. Using just the first name for this index
0
+ # [<tt>:first</tt>, <tt>:last</tt>], the DBMS creates an index for both columns as well as an
0
+ # index for the first column <tt>:first</tt>. Using just the first name for this index
0
       # makes sense, because you will never have to create a singular index with this
0
       # name.
0
       #
...
77
78
79
80
 
81
82
83
84
85
86
 
 
87
88
89
...
77
78
79
 
80
81
82
83
84
 
 
85
86
87
88
89
0
@@ -77,13 +77,13 @@ module ActiveRecord
0
       end
0
 
0
       # Returns the name of the macro. For example, <tt>composed_of :balance, :class_name => 'Money'</tt> will return
0
- # +:balance+ or for <tt>has_many :clients</tt> it will return +:clients+.
0
+ # <tt>:balance</tt> or for <tt>has_many :clients</tt> it will return <tt>:clients</tt>.
0
       def name
0
         @name
0
       end
0
 
0
- # Returns the macro type. For example, <tt>composed_of :balance, :class_name => 'Money'</tt> will return +:composed_of+
0
- # or for <tt>has_many :clients</tt> will return +:has_many+.
0
+ # Returns the macro type. For example, <tt>composed_of :balance, :class_name => 'Money'</tt> will return <tt>:composed_of</tt>
0
+ # or for <tt>has_many :clients</tt> will return <tt>:has_many</tt>.
0
       def macro
0
         @macro
0
       end

Comments

    No one has commented yet.