From e06dfda91862d8c5015b0036c59d829359ed7f7b Mon Sep 17 00:00:00 2001 From: Gabriel Hurley Date: Fri, 18 Feb 2011 06:50:13 +0000 Subject: [PATCH] Fixed #15328 -- Corrected an example in the CBV docs and added a note about the parameters passed by method_deorator to the method on the class. Thanks to airstrike for the report and lrekucki for the correction. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15563 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/topics/class-based-views.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/topics/class-based-views.txt b/docs/topics/class-based-views.txt index 516a3150ed46d..7446f6ab92237 100644 --- a/docs/topics/class-based-views.txt +++ b/docs/topics/class-based-views.txt @@ -605,8 +605,15 @@ that it can be used on an instance method. For example:: template_name = 'secret.html' @method_decorator(login_required) - def dispatch(self, **kwargs): + def dispatch(self, *args, **kwargs): return super(ProtectedView, self).dispatch(**kwargs) -In this example, every instance of :class:`ProtectedView` will have +In this example, every instance of ``ProtectedView`` will have login protection. + +.. note:: + + ``method_decorator`` passes ``*args`` and ``**kwargs`` + as parameters to the decorated method on the class. If your method + does not accept a compatible set of parameters it will raise a + ``TypeError`` exception. \ No newline at end of file