Added Subscription example to rdoc.

nbibler · Dec 13, 2008 · c4b00b1 · c4b00b1
1 parent 96547a9
commit c4b00b1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/simplepay/services/subscription.rb b/lib/simplepay/services/subscription.rb
@@ -36,6 +36,16 @@ module Services
     # start_date:: Instructs Amazon with the timestamp to start the recurring subscription charges.
     # subscription_period:: Defines the expiration window of the subscription (i.e. charge +amount+ every +recurring_frequency+ for "36 months")
     # 
+    # === Example
+    # 
+    #     (in your view, using the form helper)
+    #     
+    #     <%= simplepay_form_for(:subscription, {
+    #           :amount               => 12.95,
+    #           :recurring_frequency  => "1 year",
+    #           :description          => "My.Url Yearly Dues"
+    #     }) %>
+    # 
     class Subscription < Service
 
       required_field :access_key