From 7143d80147ea26c66dfa1dd4bb82f066d72f6570 Mon Sep 17 00:00:00 2001 From: Marcel Molina Date: Thu, 8 Nov 2007 03:37:16 +0000 Subject: Smattering of grammatical fixes to documentation. Closes #10083 [BobSilva] git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8113 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- .../abstract/connection_specification.rb | 8 ++++---- .../connection_adapters/abstract/database_statements.rb | 5 +++-- .../connection_adapters/abstract/schema_definitions.rb | 4 ++-- .../connection_adapters/abstract/schema_statements.rb | 6 +++--- .../connection_adapters/postgresql_adapter.rb | 16 ++++++++-------- .../active_record/connection_adapters/sqlite_adapter.rb | 2 +- 6 files changed, 21 insertions(+), 20 deletions(-) (limited to 'activerecord/lib/active_record/connection_adapters') diff --git a/activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb b/activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb index 801cb23362..51b90d3c64 100644 --- a/activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb +++ b/activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb @@ -243,7 +243,7 @@ module ActiveRecord end # Locate the connection of the nearest super class. This can be an - # active or defined connections: if it is the latter, it will be + # active or defined connection: if it is the latter, it will be # opened and set as the active connection for the class it was defined # for (not necessarily the current class). def self.retrieve_connection #:nodoc: @@ -264,15 +264,15 @@ module ActiveRecord conn or raise ConnectionNotEstablished end - # Returns true if a connection that's accessible to this class have already been opened. + # Returns true if a connection that's accessible to this class has already been opened. def self.connected? active_connections[active_connection_name] ? true : false end # Remove the connection for this class. This will close the active # connection and the defined connection (if they exist). The result - # can be used as argument for establish_connection, for easy - # re-establishing of the connection. + # can be used as an argument for establish_connection, for easily + # re-establishing the connection. def self.remove_connection(klass=self) spec = @@defined_connections[klass.name] konn = active_connections[klass.name] diff --git a/activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb b/activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb index 066baaba45..589acd3945 100644 --- a/activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb +++ b/activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb @@ -98,7 +98,7 @@ module ActiveRecord add_limit_offset!(sql, options) if options end - # Appends +LIMIT+ and +OFFSET+ options to a SQL statement. + # Appends +LIMIT+ and +OFFSET+ options to an SQL statement. # This method *modifies* the +sql+ parameter. # ===== Examples # add_limit_offset!('SELECT * FROM suppliers', {:limit => 10, :offset => 50}) @@ -113,7 +113,8 @@ module ActiveRecord end end - # Appends a locking clause to a SQL statement. *Modifies the +sql+ parameter*. + # Appends a locking clause to an SQL statement. + # This method *modifies* the +sql+ parameter. # # SELECT * FROM suppliers FOR UPDATE # add_lock! 'SELECT * FROM suppliers', :lock => true # add_lock! 'SELECT * FROM suppliers', :lock => ' FOR UPDATE' 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 6bd56fd3c8..c6cdc776d6 100644 --- a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb +++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb @@ -272,7 +272,7 @@ module ActiveRecord end # Represents a SQL table in an abstract way. - # Columns are stored as ColumnDefinition in the #columns attribute. + # Columns are stored as a ColumnDefinition in the #columns attribute. class TableDefinition attr_accessor :columns @@ -451,7 +451,7 @@ module ActiveRecord alias :belongs_to :references # Returns a String whose contents are the column definitions - # concatenated together. This string can then be pre and appended to + # concatenated together. This string can then be prepended and appended to # to generate the final SQL to create the table. def to_sql @columns * ', ' 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 d4fcded32a..8f981438df 100644 --- a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb +++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb @@ -54,7 +54,7 @@ module ActiveRecord # [:temporary] # Make a temporary table. # [:force] - # Set to true or false to drop the table before creating it. + # Set to true to drop the table before creating it. # Defaults to false. # # ===== Examples @@ -160,13 +160,13 @@ module ActiveRecord # Adds a new index to the table. +column_name+ can be a single Symbol, or # an Array of Symbols. # - # The index will be named after the table and the first column names, + # The index will be named after the table and the first column name, # unless you pass +:name+ as an option. # # When creating an index on multiple columns, the first column is used as a name # for the index. For example, when you specify an index on two columns # [+:first+, +:last+], the DBMS creates an index for both columns as well as an - # index for the first colum +:first+. Using just the first name for this index + # index for the first column +:first+. Using just the first name for this index # makes sense, because you will never have to create a singular index with this # name. # diff --git a/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb b/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb index bf8fed1111..64f314a7f6 100644 --- a/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb +++ b/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb @@ -18,7 +18,7 @@ module ActiveRecord raise ArgumentError, "No database specified. Missing argument: database." end - # The postgres drivers don't allow to create an unconnected PGconn object, + # The postgres drivers don't allow the creation of an unconnected PGconn object, # so just pass a nil connection object for the time being. ConnectionAdapters::PostgreSQLAdapter.new(nil, logger, [host, port, nil, nil, database, username, password], config) end @@ -217,8 +217,8 @@ module ActiveRecord # * :password -- Defaults to nothing # * :database -- The name of the database. No default, must be provided. # * :schema_search_path -- An optional schema search path for the connection given as a string of comma-separated schema names. This is backward-compatible with the :schema_order option. - # * :encoding -- An optional client encoding that is using in a SET client_encoding TO call on connection. - # * :min_messages -- An optional client min messages that is using in a SET client_min_messages TO call on connection. + # * :encoding -- An optional client encoding that is used in a SET client_encoding TO call on the connection. + # * :min_messages -- An optional client min messages that is used in a SET client_min_messages TO call on the connection. # * :allow_concurrency -- If true, use async query methods so Ruby threads don't deadlock; otherwise, use blocking query methods. class PostgreSQLAdapter < AbstractAdapter # Returns 'PostgreSQL' as adapter name for identification purposes. @@ -398,7 +398,7 @@ module ActiveRecord end end - # Executes a SQL statement, returning a PGresult object on success + # Executes an SQL statement, returning a PGresult object on success # or raising a PGError exception otherwise. def execute(sql, name = nil) log(sql, name) do @@ -478,7 +478,7 @@ module ActiveRecord # Returns the list of all column definitions for a table. def columns(table_name, name = nil) - # Limit, precision, and scale are all handled by superclass. + # Limit, precision, and scale are all handled by the superclass. column_definitions(table_name).collect do |name, type, default, notnull| PostgreSQLColumn.new(name, default, type, notnull == 'f') end @@ -669,7 +669,7 @@ module ActiveRecord sql << order_columns * ', ' end - # Returns a ORDER BY clause for the passed order option. + # Returns an ORDER BY clause for the passed order option. # # PostgreSQL does not allow arbitrary ordering when using DISTINCT ON, so we work around this # by wrapping the sql as a sub-select and ordering in that query. @@ -761,7 +761,7 @@ module ActiveRecord end # Executes a SELECT query and returns the results, performing any data type - # conversions that require to be performed here instead of in PostgreSQLColumn. + # conversions that are required to be performed here instead of in PostgreSQLColumn. def select(sql, name = nil) fields, rows = select_raw(sql, name) result = [] @@ -791,7 +791,7 @@ module ActiveRecord # fields that call value_before_type_cast. if res.type(cell_index) == MONEY_COLUMN_TYPE_OID # Because money output is formatted according to the locale, there are two - # cases to consider (note the decimal seperators): + # cases to consider (note the decimal separators): # (1) $12,345,678.12 # (2) $12.345.678,12 case column = row[cell_index] diff --git a/activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb b/activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb index c171b0239e..586594e0ef 100644 --- a/activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb +++ b/activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb @@ -34,7 +34,7 @@ module ActiveRecord # Allow database path relative to RAILS_ROOT, but only if # the database path is not the special path that tells - # Sqlite build a database only in memory. + # Sqlite to build a database only in memory. if Object.const_defined?(:RAILS_ROOT) && ':memory:' != config[:database] config[:database] = File.expand_path(config[:database], RAILS_ROOT) end -- cgit v1.2.3