Moving the LICENSE file to the root.

[philo.git] / philo / views.py

diff --git a/philo/views.py b/philo/views.py
index 28740fd..d3054b9 100644 (file)
--- a/philo/views.py
+++ b/philo/views.py
@@ -8,6 +8,17 @@ from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED
 
 @vary_on_headers('Accept')
 def node_view(request, path=None, **kwargs):
 
 @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
        
        if "philo.middleware.RequestNodeMiddleware" not in settings.MIDDLEWARE_CLASSES:
                raise MIDDLEWARE_NOT_CONFIGURED