Changeset 4879

Timestamp:

03/31/07 06:35:06 (2 years ago)

Author:

mtredinnick

Message:

Fixed #3540 -- Updated permalink documentation to fix an error and document how
to pass keyword arguments.

Files:

• django/trunk/docs/model-api.txt (modified) (1 diff)

django/trunk/docs/model-api.txt

@@ -1759 +1759 @@
-
-You can further decouple your models from the URLconf using the ``permalink``
-
-
-
+
+
+
+
+
+
+
+
+
-
-    from django.db.models import permalink
-
-    def get_absolute_url(self):
-str(self.id)
+[str(self.id)]
-    get_absolute_url = permalink(get_absolute_url)
+
+
+Similraly, if you had a URLconf entry that looked like::
+
+    (r'/archive/(?P<year>\d{4})/(?P<month>\d{1,2})/(?P<day>\d{1,2})/$',
+        archive_view)
+
+...you could reference this using ``permalink()`` as follows::
+
+    def get_absolute_url(self):
+        return ('archive_view', (), {
+            'year': self.created.year,
+            'month': self.created.month,
+            'day': self.created.day})
+    get_absolute_url = permalink(get_absolute_url)
+
+Notice that we specify an empty sequence for the second argument in this case,
+since we're only wanting to pass in some keyword arguments.
-
-In this way, you're tying the model's absolute URL to the view that is used