Bits of cleanup

1 files changed, 14 insertions, 0 deletions

diff --git a/djangorestframework/urls.py b/djangorestframework/urls.py
index 3fa813ea..e446c396 100644
--- a/djangorestframework/urls.py
+++ b/djangorestframework/urls.py
@@ -1,3 +1,17 @@
+"""
+Login and logout views for the browseable API.
+
+Add these to your root URLconf if you're using the browseable API and
+your API requires authentication.
+
+The urls must be namespaced as 'djangorestframework', and you should make sure
+your authentication settings include `SessionAuthentication`.
+
+    urlpatterns = patterns('',
+        ...
+        url(r'^auth', include('djangorestframework.urls', namespace='djangorestframework'))
+    )
+"""
 from django.conf.urls.defaults import patterns, url