Permalink
Browse files

Fixed documentation snafus #575, #576, #577, #585

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@525 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent 9b0fd9d commit 098fa943565e06dafa67ca59ccf433939d2941b4 @dhh dhh committed Feb 7, 2005
Showing with 94 additions and 92 deletions.
  1. +1 −1 actionpack/lib/action_controller/assertions/action_pack_assertions.rb
  2. +1 −1 actionpack/lib/action_controller/base.rb
  3. +1 −1 actionpack/lib/action_controller/caching.rb
  4. +2 −2 actionpack/lib/action_controller/cgi_ext/cgi_ext.rb
  5. +1 −1 actionpack/lib/action_controller/cookies.rb
  6. +1 −1 actionpack/lib/action_controller/filters.rb
  7. +3 −3 actionpack/lib/action_controller/flash.rb
  8. +2 −2 actionpack/lib/action_controller/layout.rb
  9. +1 −1 actionpack/lib/action_controller/request.rb
  10. +1 −1 actionpack/lib/action_controller/rescue.rb
  11. +4 −4 actionpack/lib/action_controller/scaffolding.rb
  12. +2 −2 actionpack/lib/action_controller/session/mem_cache_store.rb
  13. +1 −1 actionpack/lib/action_controller/url_rewriter.rb
  14. +2 −2 actionpack/lib/action_view/base.rb
  15. +1 −1 actionpack/lib/action_view/helpers/active_record_helper.rb
  16. +6 −6 actionpack/lib/action_view/helpers/form_options_helper.rb
  17. +1 −1 actionpack/lib/action_view/partials.rb
  18. +3 −3 actionpack/lib/action_view/vendor/builder/xmlbase.rb
  19. +1 −1 actionpack/test/controller/action_pack_assertions_test.rb
  20. +2 −2 activerecord/lib/active_record/aggregations.rb
  21. +5 −5 activerecord/lib/active_record/associations.rb
  22. +1 −1 activerecord/lib/active_record/associations/association_collection.rb
  23. +9 −9 activerecord/lib/active_record/base.rb
  24. +2 −2 activerecord/lib/active_record/callbacks.rb
  25. +1 −1 activerecord/lib/active_record/connection_adapters/abstract_adapter.rb
  26. +3 −3 activerecord/lib/active_record/connection_adapters/sqlserver_adapter.rb
  27. +1 −1 activerecord/lib/active_record/fixtures.rb
  28. +2 −2 activerecord/lib/active_record/transactions.rb
  29. +3 −3 activerecord/lib/active_record/validations.rb
  30. +2 −2 activerecord/lib/active_record/wrappings.rb
  31. +19 −19 activerecord/test/associations_test.rb
  32. +1 −1 activerecord/test/base_test.rb
  33. +4 −4 activerecord/test/deprecated_associations_test.rb
  34. +2 −2 activesupport/lib/inflector.rb
  35. +2 −0 railties/CHANGELOG
@@ -99,7 +99,7 @@ def assert_flash_not_exists(message=nil)
assert_block(msg) { !response.has_flash? }
end
- # ensure the flash is empty but existant
+ # ensure the flash is empty but existent
def assert_flash_empty(message=nil)
response = acquire_assertion_target
msg = build_message(message, "the flash is not empty <?>", response.flash)
@@ -558,7 +558,7 @@ def redirect_to_url(url, permanently = false) #:doc:
@performed_redirect = true
end
- # Resets the session by clearsing out all the objects stored within and initializing a new session object.
+ # Resets the session by clearing out all the objects stored within and initializing a new session object.
def reset_session #:doc:
@request.reset_session
@session = @request.session
@@ -23,7 +23,7 @@ def self.append_features(base) #:nodoc:
# are treated the same. Content management systems -- including weblogs and wikis -- have many pages that are a great fit
# for this approach, but account-based systems where people log in and manipulate their own data are often less likely candidates.
#
- # Specifying which actions to cach is done through the <tt>caches</tt> class method:
+ # Specifying which actions to cache is done through the <tt>caches</tt> class method:
#
# class WeblogController < ActionController::Base
# caches_page :show, :new
@@ -4,7 +4,7 @@
require 'action_controller/cgi_ext/cgi_methods'
# Wrapper around the CGIMethods that have been secluded to allow testing without
-# an instatiated CGI object
+# an instantiated CGI object
class CGI #:nodoc:
class << self
alias :escapeHTML_fail_on_nil :escapeHTML
@@ -40,4 +40,4 @@ def session(parameters = nil)
parameters['database_manager'] = CGI::Session::PStore
CGI::Session.new(self, parameters)
end
-end
+end
@@ -1,7 +1,7 @@
module ActionController #:nodoc:
# Cookies are read and written through ActionController#cookies. The cookies being read is what was received along with the request,
# the cookies being written is what will be sent out will the response. Cookies are read by value (so you won't get the cookie object
- # itself back -- just the value it holds). Examples for writting:
+ # itself back -- just the value it holds). Examples for writing:
#
# cookies["user_name"] = "david" # => Will set a simple session cookie
# cookies["login"] = { :value => "XJ-122", :expires => Time.now + 360} # => Will set a cookie that expires in 1 hour
@@ -100,7 +100,7 @@ def self.append_features(base)
# == Around filters
#
# In addition to the individual before and after filters, it's also possible to specify that a single object should handle
- # both the before and after call. That's especially usefuly when you need to keep state active between the before and after,
+ # both the before and after call. That's especially useful when you need to keep state active between the before and after,
# such as the example of a benchmark filter below:
#
# class WeblogController < ActionController::Base
@@ -1,13 +1,13 @@
module ActionController #:nodoc:
# The flash provides a way to pass temporary objects between actions. Anything you place in the flash will be exposed
# to the very next action and then cleared out. This is a great way of doing notices and alerts, such as a create action
- # that sets <tt>flash["notice"] = "Succesfully created"</tt> before redirecting to a display action that can then expose
+ # that sets <tt>flash["notice"] = "Successfully created"</tt> before redirecting to a display action that can then expose
# the flash to its template. Actually, that exposure is automatically done. Example:
#
# class WeblogController < ActionController::Base
# def create
# # save post
- # flash["notice"] = "Succesfully created post"
+ # flash["notice"] = "Successfully created post"
# redirect_to :action => "display", :params => { "id" => post.id }
# end
#
@@ -62,4 +62,4 @@ def clear_flash
end
end
end
-end
+end
@@ -65,7 +65,7 @@ class << self
# <tt>app/views/layouts/weblog.rhtml</tt> or <tt>app/views/layouts/weblog.rxml</tt> exists then it will be automatically set as
# the layout for your WeblogController. You can create a layout with the name <tt>application.rhtml</tt> or <tt>application.rxml</tt>
# and this will be set as the default controller if there is no layout with the same name as the current controller and there is
- # no layout explicitly assigned with the +layout+ method. Setting a layout explicity will always override the automatic behaviour.
+ # no layout explicitly assigned with the +layout+ method. Setting a layout explicitly will always override the automatic behaviour.
#
# == Inheritance for layouts
#
@@ -136,7 +136,7 @@ class << self
# This will assign "weblog_standard" as the WeblogController's layout except for the +rss+ action, which will not wrap a layout
# around the rendered view.
#
- # Both the +:only+ and +:except+ condition can accept an aribtrary number of method references, so +:except => [ :rss, :text_only ]+
+ # Both the +:only+ and +:except+ condition can accept an arbitrary number of method references, so +:except => [ :rss, :text_only ]+
# is valid, as is # +:except => :rss+.
#
# == Using a different layout in the action render call
@@ -65,7 +65,7 @@ def subdomains(tld_length = 1)
parts - parts.last(1 + tld_length)
end
- # Recieve the raw post data.
+ # Receive the raw post data.
# This is useful for services such as REST, XMLRPC and SOAP
# which communicate over HTTP POST but don't use the traditional parameter format.
def raw_post
@@ -51,7 +51,7 @@ def rescue_action_in_public(exception) #:doc:
render_text "<html><body><h1>Application error (Rails)</h1></body></html>"
end
- # Overwrite to expand the meaning of a local request in order to show local rescues on other occurances than
+ # Overwrite to expand the meaning of a local request in order to show local rescues on other occurences than
# the remote IP being 127.0.0.1. For example, this could include the IP of the developer machine when debugging
# remotely.
def local_request? #:doc:
@@ -44,7 +44,7 @@ def self.append_features(base)
# def create
# @entry = Entry.new(@params["entry"])
# if @entry.save
- # flash["notice"] = "Entry was succesfully created"
+ # flash["notice"] = "Entry was successfully created"
# redirect_to :action => "list"
# else
# render "entry/new"
@@ -61,7 +61,7 @@ def self.append_features(base)
# @entry.attributes = @params["entry"]
#
# if @entry.save
- # flash["notice"] = "Entry was succesfully updated"
+ # flash["notice"] = "Entry was successfully updated"
# redirect_to :action => "show/" + @entry.id.to_s
# else
# render "entry/edit"
@@ -123,7 +123,7 @@ def new#{suffix}
def create#{suffix}
@#{singular_name} = #{class_name}.new(@params["#{singular_name}"])
if @#{singular_name}.save
- flash["notice"] = "#{class_name} was succesfully created"
+ flash["notice"] = "#{class_name} was successfully created"
redirect_to :action => "list#{suffix}"
else
render "#{singular_name}/new#{suffix}"
@@ -140,7 +140,7 @@ def update#{suffix}
@#{singular_name}.attributes = @params["#{singular_name}"]
if @#{singular_name}.save
- flash["notice"] = "#{class_name} was succesfully updated"
+ flash["notice"] = "#{class_name} was successfully updated"
redirect_to :action => "show#{suffix}/" + @#{singular_name}.id.to_s
else
render "#{singular_name}/edit#{suffix}"
@@ -33,7 +33,7 @@ def check_id(id) #:nodoc:#
# characters; automatically generated session ids observe
# this requirement.
#
- # +option+ is a hash of options for the initialiser. The
+ # +option+ is a hash of options for the initializer. The
# following options are recognized:
#
# cache:: an instance of a MemCache client to use as the
@@ -92,4 +92,4 @@ def delete
end
rescue LoadError
# MemCache wasn't available so neither can the store be
-end
+end
@@ -1,5 +1,5 @@
module ActionController
- # Rewrites urls for Base.redirect_to and Base.url_for in the controller.
+ # Rewrites URLs for Base.redirect_to and Base.url_for in the controller.
class UrlRewriter #:nodoc:
VALID_OPTIONS = [:action, :action_prefix, :action_suffix, :application_prefix, :module, :controller, :controller_prefix, :anchor, :params, :path_params, :id, :only_path, :overwrite_params, :host, :protocol ]
@@ -61,12 +61,12 @@ class ActionViewError < StandardError #:nodoc:
#
# The parsing of ERb templates are cached by default, but the reading of them are not. This means that the application by default
# will reflect changes to the templates immediatly. If you'd like to sacrifice that immediacy for the speed gain given by also
- # caching the loading of templates (reading from the file systen), you can turn that on with
+ # caching the loading of templates (reading from the file system), you can turn that on with
# <tt>ActionView::Base.cache_template_loading = true</tt>.
#
# == Builder
#
- # Builder templates are a more programatic alternative to ERb. They are especially useful for generating XML content. An +XmlMarkup+ object
+ # Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An +XmlMarkup+ object
# named +xml+ is automatically made available to templates with a +.rxml+ extension.
#
# Here are some basic examples:
@@ -10,7 +10,7 @@ class Base
module Helpers
# The Active Record Helper makes it easier to create forms for records kept in instance variables. The most far-reaching is the form
# method that creates a complete form for all the basic content types of the record (not associations or aggregations, though). This
- # is a great of making the record quickly available for editing, but likely to prove lacklusters for a complicated real-world form.
+ # is a great of making the record quickly available for editing, but likely to prove lackluster for a complicated real-world form.
# In that case, it's better to use the input method and the specialized form methods in link:classes/ActionView/Helpers/FormHelper.html
module ActiveRecordHelper
# Returns a default input tag for the type of object returned by the method. Example
@@ -9,7 +9,7 @@ module FormOptionsHelper
include ERB::Util
# Create a select tag and a series of contained option tags for the provided object and method.
- # The option currenlty held by the object will be selected, provided that the object is available.
+ # The option currently held by the object will be selected, provided that the object is available.
#
# This can be used to provide a default set of options in the standard way: before rendering the create form, a
# new model instance is assigned the default options and bound to @model_name. Usually this model is not saved
@@ -40,14 +40,14 @@ def country_select(object, method, priority_countries = nil, options = {}, html_
# options_for_select([["Dollar", "$"], ["Kroner", "DKK"]])
# <option value="$">Dollar</option>\n<option value="DKK">Kroner</option>
#
- # options_for_select([ "VISA", "Mastercard" ], "Mastercard")
- # <option>VISA</option>\n<option selected="selected">Mastercard</option>
+ # options_for_select([ "VISA", "MasterCard" ], "MasterCard")
+ # <option>VISA</option>\n<option selected="selected">MasterCard</option>
#
# options_for_select({ "Basic" => "$20", "Plus" => "$40" }, "$40")
# <option value="$20">Basic</option>\n<option value="$40" selected="selected">Plus</option>
#
- # options_for_select([ "VISA", "Mastercard", "Discover" ], ["VISA", "Discover"])
- # <option selected="selected">VISA</option>\n<option>Mastercard</option>\n<option selected="selected">Discover</option>
+ # options_for_select([ "VISA", "MasterCard", "Discover" ], ["VISA", "Discover"])
+ # <option selected="selected">VISA</option>\n<option>MasterCard</option>\n<option selected="selected">Discover</option>
def options_for_select(container, selected = nil)
container = container.to_a if Hash === container
@@ -87,7 +87,7 @@ def options_from_collection_for_select(collection, value_method, text_method, se
# An array of group objects are passed. Each group should return an array of options when calling group_method
# Each group should should return its name when calling group_label_method.
#
- # html_option_groups_from_collection(@continents, "countries", "contient_name", "country_id", "country_name", @selected_country.id)
+ # html_option_groups_from_collection(@continents, "countries", "continent_name", "country_id", "country_name", @selected_country.id)
#
# Could become:
# <optgroup label="Africa">
@@ -12,7 +12,7 @@ module ActionView
#
# == Rendering a collection of partials
#
- # The example of partial use describes a familar pattern where a template needs to iterate over an array and render a sub
+ # The example of partial use describes a familiar pattern where a template needs to iterate over an array and render a sub
# template for each of the elements. This pattern has been implemented as a single method that accepts an array and renders
# a partial by the same name as the elements contained within. So the three-lined example in "Using partials" can be rewritten
# with a single line:
@@ -76,15 +76,15 @@ def method_missing(sym, *args, &block)
end
# Append text to the output target. Escape any markup. May be
- # used within the markup brakets as:
+ # used within the markup brackets as:
#
# builder.p { br; text! "HI" } #=> <p><br/>HI</p>
def text!(text)
_text(_escape(text))
end
# Append text to the output target without escaping any markup.
- # May be used within the markup brakets as:
+ # May be used within the markup brackets as:
#
# builder.p { |x| x << "<br/>HI" } #=> <p><br/>HI</p>
#
@@ -94,7 +94,7 @@ def text!(text)
#
# It is also useful for stacking builder objects. Builders only
# use <tt><<</tt> to append to the target, so by supporting this
- # method/operation builders can use oother builders as their
+ # method/operation builders can use other builders as their
# targets.
def <<(text)
_text(text)
@@ -195,7 +195,7 @@ def test_assert_success
assert_success
end
- # -- standard request/reponse object testing --------------------------------
+ # -- standard request/response object testing --------------------------------
# ensure our session is working properly
def test_session_objects
@@ -94,7 +94,7 @@ def self.append_features(base)
# relational unique identifiers (such as primary keys). Normal ActiveRecord::Base classes are entity objects.
#
# It's also important to treat the value objects as immutable. Don't allow the Money object to have its amount changed after
- # creation. Create a new money object with the new value instead. This is examplified by the Money#exchanged_to method that
+ # creation. Create a new money object with the new value instead. This is exemplified by the Money#exchanged_to method that
# returns a new value object instead of changing its own values. Active Record won't persist value objects that have been
# changed through other means than the writer method.
#
@@ -108,7 +108,7 @@ module ClassMethods
# <tt>composed_of :address</tt> would add <tt>address</tt> and <tt>address=(new_address)</tt>.
#
# Options are:
- # * <tt>:class_name</tt> - specify the class name of the association. Use it only if that name can't be infered
+ # * <tt>:class_name</tt> - specify the class name of the association. Use it only if that name can't be inferred
# from the part id. So <tt>composed_of :address</tt> will by default be linked to the +Address+ class, but
# if the real class name is +CompanyAddress+, you'll have to specify it with this option.
# * <tt>:mapping</tt> - specifies a number of mapping arrays (attribute, parameter) that bind an attribute name
Oops, something went wrong.

0 comments on commit 098fa94

Please sign in to comment.