From 6907bfe1ab9ab9397da51017eee62848a970e443 Mon Sep 17 00:00:00 2001
From: Rizwan Reza <rizwanreza@gmail.com>
Date: Tue, 15 Jun 2010 22:13:30 +0430
Subject: Minor doc changes to active_model/validations/acceptance.rb

---
 .../lib/active_model/validations/acceptance.rb     | 45 ++++++++++++++--------
 1 file changed, 30 insertions(+), 15 deletions(-)

(limited to 'activemodel')

diff --git a/activemodel/lib/active_model/validations/acceptance.rb b/activemodel/lib/active_model/validations/acceptance.rb
index 26b12b504b..77c401e0cc 100644
--- a/activemodel/lib/active_model/validations/acceptance.rb
+++ b/activemodel/lib/active_model/validations/acceptance.rb
@@ -1,4 +1,6 @@
 module ActiveModel
+
+  # == Active Model Acceptance Validator
   module Validations
     class AcceptanceValidator < EachValidator
       def initialize(options)
@@ -22,29 +24,42 @@ module ActiveModel
     end
 
     module HelperMethods
-      # Encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example:
+      # Encapsulates the pattern of wanting to validate the acceptance of a 
+      # terms of service check box (or similar agreement). Example:
       #
       #   class Person < ActiveRecord::Base
       #     validates_acceptance_of :terms_of_service
       #     validates_acceptance_of :eula, :message => "must be abided"
       #   end
       #
-      # If the database column does not exist, the +terms_of_service+ attribute is entirely virtual. This check is
-      # performed only if +terms_of_service+ is not +nil+ and by default on save.
+      # If the database column does not exist, the +terms_of_service+ attribute 
+      # is entirely virtual. This check is performed only if +terms_of_service+
+      # is not +nil+ and by default on save.
       #
       # Configuration options:
-      # * <tt>:message</tt> - A custom error message (default is: "must be accepted").
-      # * <tt>:on</tt> - Specifies when this validation is active (default is <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
-      # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default is true).
-      # * <tt>:accept</tt> - Specifies value that is considered accepted.  The default value is a string "1", which
-      #   makes it easy to relate to an HTML checkbox. This should be set to +true+ if you are validating a database
-      #   column, since the attribute is typecast from "1" to +true+ before validation.
-      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>).  The
-      #   method, proc or string should return or evaluate to a true or false value.
-      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>).  The
-      #   method, proc or string should return or evaluate to a true or false value.
+      # * <tt>:message</tt> - A custom error message (default is: "must be 
+      #   accepted").
+      # * <tt>:on</tt> - Specifies when this validation is active (default is
+      #   <tt>:save</tt>, other options are <tt>:create</tt> and 
+      #   <tt>:update</tt>).
+      # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default
+      #   is true).
+      # * <tt>:accept</tt> - Specifies value that is considered accepted. 
+      #   The default value is a string "1", which makes it easy to relate to
+      #   an HTML checkbox. This should be set to +true+ if you are validating 
+      #   a database column, since the attribute is typecast from "1" to +true+
+      #   before validation.
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
+      #   if the validation should occur (e.g. <tt>:if => :allow_validation</tt>,
+      #   or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>).  The
+      #   method, proc or string should return or evaluate to a true or false 
+      #   value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to 
+      #   determine if the validation should not occur (for example, 
+      #   <tt>:unless => :skip_validation</tt>, or 
+      #   <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>).
+      #   The method, proc or string should return or evaluate to a true or 
+      #   false value.
       def validates_acceptance_of(*attr_names)
         validates_with AcceptanceValidator, _merge_attributes(attr_names)
       end
-- 
cgit v1.2.3