aboutsummaryrefslogtreecommitdiffstats
path: root/rest_framework
diff options
context:
space:
mode:
authorKevin London2014-08-07 11:02:48 -0700
committerKevin London2014-08-07 11:02:48 -0700
commitaac864a55f8aec80f35d43052b67c2558814df16 (patch)
tree06162edcf8730a3791ed89561e1aff5d9e5f93bb /rest_framework
parent31591d6cfca7d19a21c214b98e9256ed8b28182f (diff)
downloaddjango-rest-framework-aac864a55f8aec80f35d43052b67c2558814df16.tar.bz2
Updated documentation for urls.py
I made a small change in the order of the documentation for urls.py. I feel it helps make it clear which lines you should add to the root settings.
Diffstat (limited to 'rest_framework')
-rw-r--r--rest_framework/urls.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/rest_framework/urls.py b/rest_framework/urls.py
index 9c4719f1..5d70f899 100644
--- a/rest_framework/urls.py
+++ b/rest_framework/urls.py
@@ -2,15 +2,15 @@
Login and logout views for the browsable API.
Add these to your root URLconf if you're using the browsable API and
-your API requires authentication.
-
-The urls must be namespaced as 'rest_framework', and you should make sure
-your authentication settings include `SessionAuthentication`.
+your API requires authentication:
urlpatterns = patterns('',
...
url(r'^auth', include('rest_framework.urls', namespace='rest_framework'))
)
+
+The urls must be namespaced as 'rest_framework', and you should make sure
+your authentication settings include `SessionAuthentication`.
"""
from __future__ import unicode_literals
from rest_framework.compat import patterns, url