From 5277d550d9a2039f82922ce9aca85ea4db5eb615 Mon Sep 17 00:00:00 2001
From: Vijay Dev <vijaydev.cse@gmail.com>
Date: Thu, 10 May 2012 17:24:53 +0530
Subject: remove unnecessary 'examples' noise [ci skip]

---
 .../abstract/schema_statements.rb                  | 22 +++++++---------------
 1 file changed, 7 insertions(+), 15 deletions(-)

(limited to 'activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb')

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
-- 
cgit v1.2.3