From 0083a4c8e9d3b8fcc237b1dce1c5412d342b7de2 Mon Sep 17 00:00:00 2001
From: Tim Graham <timograham@gmail.com>
Date: Tue, 4 Oct 2016 14:39:49 -0400
Subject: Refs #18974 -- Deprecated @models.permalink() decorator.

---
 docs/internals/deprecation.txt |  2 ++
 docs/releases/1.11.txt         | 25 +++++++++++++++++++++++++
 2 files changed, 27 insertions(+)

(limited to 'docs')

diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index a1c55646d0..a7ef1b8be5 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -41,6 +41,8 @@ details on these changes.
 * The ``authenticate()`` method of authentication backends will require a
   ``request`` argument.
 
+* The ``django.db.models.permalink()`` decorator will be removed.
+
 .. _deprecation-removed-in-2.0:
 
 2.0
diff --git a/docs/releases/1.11.txt b/docs/releases/1.11.txt
index 96fb2e4ae9..142eb4e9ba 100644
--- a/docs/releases/1.11.txt
+++ b/docs/releases/1.11.txt
@@ -554,6 +554,31 @@ Miscellaneous
 Features deprecated in 1.11
 ===========================
 
+``models.permalink()`` decorator
+--------------------------------
+
+Use :func:`django.urls.reverse` instead. For example::
+
+    from django.db import models
+
+    class MyModel(models.Model):
+        ...
+
+        @models.permalink
+        def url(self):
+            return ('guitarist_detail', [self.slug])
+
+becomes::
+
+    from django.db import models
+    from django.urls import reverse
+
+    class MyModel(models.Model):
+        ...
+
+        def url(self):
+            return reverse('guitarist_detail', args=[self.slug])
+
 Miscellaneous
 -------------
 
-- 
cgit v1.3