remove unnecessary 'examples' noise [ci skip]

2 files changed, 18 insertions, 28 deletions

diff --git a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
index f0b6ae2b7d..f17baec722 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
@@ -262,7 +262,7 @@ module ActiveRecord
       
       # Adds index options to the indexes hash, keyed by column name
       # This is primarily used to track indexes that need to be created after the table
-      # === Examples
+      #
       #   index(:account_id, :name => 'index_projects_on_account_id')
       def index(column_name, options = {})
         indexes[column_name] = options
@@ -348,7 +348,7 @@ module ActiveRecord
 
       # Adds a new column to the named table.
       # See TableDefinition#column for details of the options you can use.
-      # ===== Example
+      #
       # ====== Creating a simple column
       #  t.column(:name, :string)
       def column(column_name, type, options = {})
@@ -363,7 +363,6 @@ module ActiveRecord
       # Adds a new index to the table. +column_name+ can be a single Symbol, or
       # an Array of Symbols. See SchemaStatements#add_index
       #
-      # ===== Examples
       # ====== Creating a simple index
       #  t.index(:name)
       # ====== Creating a unique index
@@ -380,7 +379,7 @@ module ActiveRecord
       end
 
       # Adds timestamps (+created_at+ and +updated_at+) columns to the table. See SchemaStatements#add_timestamps
-      # ===== Example
+      #
       #  t.timestamps
       def timestamps
         @base.add_timestamps(@table_name)
@@ -388,7 +387,7 @@ module ActiveRecord
 
       # Changes the column's definition according to the new options.
       # See TableDefinition#column for details of the options you can use.
-      # ===== Examples
+      #
       #  t.change(:name, :string, :limit => 80)
       #  t.change(:description, :text)
       def change(column_name, type, options = {})
@@ -396,7 +395,7 @@ module ActiveRecord
       end
 
       # Sets a new default value for a column. See SchemaStatements#change_column_default
-      # ===== Examples
+      #
       #  t.change_default(:qualification, 'new')
       #  t.change_default(:authorized, 1)
       def change_default(column_name, default)
@@ -404,7 +403,7 @@ module ActiveRecord
       end
 
       # Removes the column(s) from the table definition.
-      # ===== Examples
+      #
       #  t.remove(:qualification)
       #  t.remove(:qualification, :experience)
       def remove(*column_names)
@@ -413,7 +412,6 @@ module ActiveRecord
 
       # Removes the given index from the table.
       #
-      # ===== Examples
       # ====== Remove the index_table_name_on_column in the table_name table
       #   t.remove_index :column
       # ====== Remove the index named index_table_name_on_branch_id in the table_name table
@@ -427,14 +425,14 @@ module ActiveRecord
       end
 
       # Removes the timestamp columns (+created_at+ and +updated_at+) from the table.
-      # ===== Example
+      #
       #  t.remove_timestamps
       def remove_timestamps
         @base.remove_timestamps(@table_name)
       end
 
       # Renames a column.
-      # ===== Example
+      #
       #  t.rename(:description, :name)
       def rename(column_name, new_column_name)
         @base.rename_column(@table_name, column_name, new_column_name)
@@ -442,7 +440,7 @@ module ActiveRecord
 
       # Adds a reference. Optionally adds a +type+ column, if <tt>:polymorphic</tt> option is provided.
       # <tt>references</tt> and <tt>belongs_to</tt> are acceptable.
-      # ===== Examples
+      #
       #  t.references(:goat)
       #  t.references(:goat, :polymorphic => true)
       #  t.belongs_to(:goat)
@@ -460,7 +458,7 @@ module ActiveRecord
 
       # Removes a reference. Optionally removes a +type+ column.
       # <tt>remove_references</tt> and <tt>remove_belongs_to</tt> are acceptable.
-      # ===== Examples
+      #
       #  t.remove_references(:goat)
       #  t.remove_references(:goat, :polymorphic => true)
       #  t.remove_belongs_to(:goat)
@@ -475,7 +473,7 @@ module ActiveRecord
       alias :remove_belongs_to  :remove_references
 
       # Adds a column or columns of a specified type
-      # ===== Examples
+      #
       #  t.string(:goat)
       #  t.string(:goat, :sheep)
       %w( string text integer float decimal datetime timestamp time date binary boolean ).each do |column_type|
diff --git a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
index e7a4f061fd..62b0f51bb2 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
@@ -21,7 +21,6 @@ module ActiveRecord
 
       # Checks to see if the table +table_name+ exists on the database.
       #
-      # === Example
       #   table_exists?(:developers)
       def table_exists?(table_name)
         tables.include?(table_name.to_s)
@@ -32,7 +31,6 @@ module ActiveRecord
 
       # Checks to see if an index exists on a table for a given index definition.
       #
-      # === Examples
       #  # Check an index exists
       #  index_exists?(:suppliers, :company_id)
       #
@@ -126,7 +124,6 @@ module ActiveRecord
       #   Set to true to drop the table before creating it.
       #   Defaults to false.
       #
-      # ===== Examples
       # ====== Add a backend specific option to the generated SQL (MySQL)
       #  create_table(:suppliers, :options => 'ENGINE=InnoDB DEFAULT CHARSET=utf8')
       # generates:
@@ -193,7 +190,6 @@ module ActiveRecord
       #   Set to true to drop the table before creating it.
       #   Defaults to false.
       #
-      # ===== Examples
       # ====== Add a backend specific option to the generated SQL (MySQL)
       #  create_join_table(:assemblies, :parts, :options => 'ENGINE=InnoDB DEFAULT CHARSET=utf8')
       # generates:
@@ -215,7 +211,6 @@ module ActiveRecord
 
       # A block for changing columns in +table+.
       #
-      # === Example
       #  # change_table() yields a Table instance
       #  change_table(:suppliers) do |t|
       #    t.column :name, :string, :limit => 60
@@ -229,7 +224,6 @@ module ActiveRecord
       #
       #   Defaults to false.
       #
-      # ===== Examples
       # ====== Add a column
       #  change_table(:suppliers) do |t|
       #    t.column :name, :string, :limit => 60
@@ -288,7 +282,7 @@ module ActiveRecord
       end
 
       # Renames a table.
-      # ===== Example
+      #
       #  rename_table('octopuses', 'octopi')
       def rename_table(table_name, new_name)
         raise NotImplementedError, "rename_table is not implemented"
@@ -308,7 +302,7 @@ module ActiveRecord
       end
 
       # Removes the column(s) from the table definition.
-      # ===== Examples
+      #
       #  remove_column(:suppliers, :qualification)
       #  remove_columns(:suppliers, :qualification, :experience)
       def remove_column(table_name, *column_names)
@@ -318,7 +312,7 @@ module ActiveRecord
 
       # Changes the column's definition according to the new options.
       # See TableDefinition#column for details of the options you can use.
-      # ===== Examples
+      #
       #  change_column(:suppliers, :name, :string, :limit => 80)
       #  change_column(:accounts, :description, :text)
       def change_column(table_name, column_name, type, options = {})
@@ -326,7 +320,7 @@ module ActiveRecord
       end
 
       # Sets a new default value for a column.
-      # ===== Examples
+      #
       #  change_column_default(:suppliers, :qualification, 'new')
       #  change_column_default(:accounts, :authorized, 1)
       #  change_column_default(:users, :email, nil)
@@ -335,7 +329,7 @@ module ActiveRecord
       end
 
       # Renames a column.
-      # ===== Example
+      #
       #  rename_column(:suppliers, :description, :name)
       def rename_column(table_name, column_name, new_column_name)
         raise NotImplementedError, "rename_column is not implemented"
@@ -347,8 +341,6 @@ module ActiveRecord
       # The index will be named after the table and the column name(s), unless
       # you pass <tt>:name</tt> as an option.
       #
-      # ===== Examples
-      #
       # ====== Creating a simple index
       #  add_index(:suppliers, :name)
       # generates
@@ -537,7 +529,7 @@ module ActiveRecord
       end
 
       # Adds timestamps (created_at and updated_at) columns to the named table.
-      # ===== Examples
+      #
       #  add_timestamps(:suppliers)
       def add_timestamps(table_name)
         add_column table_name, :created_at, :datetime
@@ -545,7 +537,7 @@ module ActiveRecord
       end
 
       # Removes the timestamp columns (created_at and updated_at) from the table definition.
-      # ===== Examples
+      #
       #  remove_timestamps(:suppliers)
       def remove_timestamps(table_name)
         remove_column table_name, :updated_at