X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/cec32849d48d9e36c030224e2eb9631d31ef17a2..8318347602085438ff700b9c1d6b83f351deccd7:/philo/views.py

diff --git a/philo/views.py b/philo/views.py
index 598be36..d3054b9 100644
--- a/philo/views.py
+++ b/philo/views.py
@@ -2,11 +2,23 @@ from django.conf import settings
 from django.core.urlresolvers import resolve
 from django.http import Http404, HttpResponseRedirect
 from django.views.decorators.vary import vary_on_headers
+
 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED
 
 
 @vary_on_headers('Accept')
 def node_view(request, path=None, **kwargs):
+	"""
+	:func:`node_view` handles incoming requests by checking to make sure that:
+	
+	- the request has an attached :class:`.Node`.
+	- the attached :class:`~philo.models.nodes.Node` handles any remaining path beyond its location.
+	
+	If these conditions are not met, then :func:`node_view` will either raise :exc:`Http404` or, if it seems like the address was mistyped (for example missing a trailing slash), return an :class:`HttpResponseRedirect` to the correct address.
+	
+	Otherwise, :func:`node_view` will call the :class:`.Node`'s :meth:`~.Node.render_to_response` method, passing ``kwargs`` in as the ``extra_context``.
+	
+	"""
 	if "philo.middleware.RequestNodeMiddleware" not in settings.MIDDLEWARE_CLASSES:
 		raise MIDDLEWARE_NOT_CONFIGURED