← Back to branch summary

~vcs-imports/rails/trunk

« back to all changes in this revision

Viewing changes to activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb

  • Committer: pratik
  • Date: 2008-04-05 03:52:58 UTC
  • Revision ID: vcs-imports@canonical.com-20080405035258-83rgxjkgjpb4yef2
Improve documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
161
161
      # an Array of Symbols.
162
162
      #
163
163
      # The index will be named after the table and the first column name,
164
 
      # unless you pass +:name+ as an option.
 
164
      # unless you pass <tt>:name</tt> as an option.
165
165
      #
166
166
      # When creating an index on multiple columns, the first column is used as a name
167
167
      # for the index. For example, when you specify an index on two columns
168
 
      # [+:first+, +:last+], the DBMS creates an index for both columns as well as an
169
 
      # index for the first column +:first+. Using just the first name for this index
 
168
      # [<tt>:first</tt>, <tt>:last</tt>], the DBMS creates an index for both columns as well as an
 
169
      # index for the first column <tt>:first</tt>. Using just the first name for this index
170
170
      # makes sense, because you will never have to create a singular index with this
171
171
      # name.
172
172
      #