From 9a1c21809ed48b0d06c1e2395bf6a7c7b900f96a Mon Sep 17 00:00:00 2001 From: Gary Wilson Jr Date: Mon, 16 Jul 2007 13:47:43 +0000 Subject: [PATCH] Removed unused variable and changed comments about `permalink` decorator into a docstring. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5719 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- django/db/models/__init__.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/django/db/models/__init__.py b/django/db/models/__init__.py index 6c3abb6b59..2203cbb6fd 100644 --- a/django/db/models/__init__.py +++ b/django/db/models/__init__.py @@ -15,14 +15,18 @@ from django.utils.text import capfirst # Admin stages. ADD, CHANGE, BOTH = 1, 2, 3 -# Decorator. Takes a function that returns a tuple in this format: -# (viewname, viewargs, viewkwargs) -# Returns a function that calls urlresolvers.reverse() on that data, to return -# the URL for those parameters. def permalink(func): + """ + Decorator that calls urlresolvers.reverse() to return a URL using + parameters returned by the decorated function "func". + + "func" should be a function that returns a tuple in one of the + following formats: + (viewname, viewargs) + (viewname, viewargs, viewkwargs) + """ from django.core.urlresolvers import reverse def inner(*args, **kwargs): bits = func(*args, **kwargs) - viewname = bits[0] return reverse(bits[0], None, *bits[1:3]) return inner