Better comments

instacart · Feb 3, 2017 · 746712b · 746712b
1 parent 4c8b91f
commit 746712b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 12 deletions.
diff --git a/lib/active_record/connection_adapters/odbc_adapter.rb b/lib/active_record/connection_adapters/odbc_adapter.rb
@@ -18,7 +18,7 @@
 module ActiveRecord
   class Base
     class << self
-      def odbc_connection(config) # :nodoc:
+      def odbc_connection(config)
         config = config.symbolize_keys
 
         connection, options =

diff --git a/lib/odbc_adapter/adapters/mysql_odbc_adapter.rb b/lib/odbc_adapter/adapters/mysql_odbc_adapter.rb
@@ -49,7 +49,7 @@ def unquoted_false
         0
       end
 
-      def disable_referential_integrity(&block) #:nodoc:
+      def disable_referential_integrity(&block)
         old = select_value("SELECT @@FOREIGN_KEY_CHECKS")
 
         begin
@@ -60,13 +60,14 @@ def disable_referential_integrity(&block) #:nodoc:
         end
       end
 
-      # Create a new MySQL database with optional <tt>:charset</tt> and <tt>:collation</tt>.
-      # Charset defaults to utf8.
+      # Create a new MySQL database with optional <tt>:charset</tt> and
+      # <tt>:collation</tt>. Charset defaults to utf8.
       #
       # Example:
-      #   create_database 'charset_test', :charset => 'latin1', :collation => 'latin1_bin'
-      #   create_database 'matt_development'
-      #   create_database 'matt_development', :charset => :big5
+      #   create_database 'charset_test', charset: 'latin1',
+      #                                   collation: 'latin1_bin'
+      #   create_database 'rails_development'
+      #   create_database 'rails_development', charset: :big5
       def create_database(name, options = {})
         if options[:collation]
           execute("CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}` COLLATE `#{options[:collation]}`")
@@ -78,8 +79,8 @@ def create_database(name, options = {})
       # Drops a MySQL database.
       #
       # Example:
-      #   drop_database('sebastian_development')
-      def drop_database(name) #:nodoc:
+      #   drop_database('rails_development')
+      def drop_database(name)
         execute("DROP DATABASE IF EXISTS `#{name}`")
       end
 

diff --git a/lib/odbc_adapter/adapters/postgresql_odbc_adapter.rb b/lib/odbc_adapter/adapters/postgresql_odbc_adapter.rb
@@ -29,7 +29,7 @@ def truncate(table_name, name = nil)
 
       # Returns the sequence name for a table's primary key or some other
       # specified key.
-      def default_sequence_name(table_name, pk = nil) #:nodoc:
+      def default_sequence_name(table_name, pk = nil)
         serial_sequence(table_name, pk || 'id').split('.').last
       rescue ActiveRecord::StatementInvalid
         "#{table_name}_#{pk || 'id'}_seq"
@@ -63,7 +63,7 @@ def quote_string(string)
         string.gsub(/\\/, '\&\&').gsub(/'/, "''")
       end
 
-      def disable_referential_integrity #:nodoc:
+      def disable_referential_integrity
         execute(tables.map { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL" }.join(';'))
         yield
       ensure
@@ -105,7 +105,7 @@ def create_database(name, options = {})
       #
       # Example:
       #   drop_database 'rails_development'
-      def drop_database(name) #:nodoc:
+      def drop_database(name)
         execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
       end