Some improvements in documentation (dj-stripe#1070)

Fixes dj-stripe#924
ryancausey · Dec 7, 2019 · 240a0a6 · 240a0a6
1 parent 0dd7925
commit 240a0a6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/usage/restricting_access.rst b/docs/usage/restricting_access.rst
@@ -103,7 +103,7 @@ If you want to quickly constrain a single Class-Based View, the ``djstripe.decor
         @method_decorator(login_required)
         @method_decorator(subscription_payment_required)
         def dispatch(self, *args, **kwargs):
-            return super(MyConstrainedView, self).dispatch(*args, **kwargs)
+            return super().dispatch(*args, **kwargs)
 
 
 If you are unfamiliar with this technique please read the following documentation `here <https://docs.djangoproject.com/en/1.5/topics/class-based-views/intro/#decorating-the-class>`_.

diff --git a/docs/usage/subscribing_customers.rst b/docs/usage/subscribing_customers.rst
@@ -1,6 +1,19 @@
 Subscribing a customer to a plan
 ================================
 
+For your convenience, dj-stripe provides a ``Customer.subscribe()`` method that
+will try to charge the customer immediately unless you specify ``charge_immediately=False``
+
+.. code-block:: python
+
+    plan = Plan.objects.get(nickname="one_plan")
+    customer = Customer.objects.first()
+    customer.subscribe(plan)
+
+However in some cases ``Customer.subscribe()`` might not support all the arguments
+you need for your implementation. When this happens you can just call the
+official ``stripe.Customer.subscribe()``.
+
 See this example from ``tests.apps.example.views.PurchaseSubscriptionView.form_valid``
 
 .. literalinclude:: ../../tests/apps/example/views.py