From 1f0d9d2193bb9557d4475885776b5679c8dbfa23 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Mon, 16 Apr 2012 23:19:14 -0500
Subject: docs for json defaults

---
 docs/api/renderers.rst  |  2 --
 docs/narr/renderers.rst | 29 +++++++++++++++--------------
 2 files changed, 15 insertions(+), 16 deletions(-)

(limited to 'docs')

diff --git a/docs/api/renderers.rst b/docs/api/renderers.rst
index ab182365e..ea000ad02 100644
--- a/docs/api/renderers.rst
+++ b/docs/api/renderers.rst
@@ -15,8 +15,6 @@
 
 .. autoclass:: JSONP
 
-.. autoclass:: ObjectJSONEncoder
-
 .. attribute:: null_renderer
 
    An object that can be used in advanced integration cases as input to the
diff --git a/docs/narr/renderers.rst b/docs/narr/renderers.rst
index 34bee3c7f..50349c409 100644
--- a/docs/narr/renderers.rst
+++ b/docs/narr/renderers.rst
@@ -223,9 +223,9 @@ You can configure a view to use the JSON renderer by naming ``json`` as the
    :linenos:
 
    config.add_view('myproject.views.hello_world',
-                    name='hello',
-                    context='myproject.resources.Hello',
-                    renderer='json')
+                   name='hello',
+                   context='myproject.resources.Hello',
+                   renderer='json')
 
 Views which use the JSON renderer can vary non-body response attributes by
 using the api of the ``request.response`` attribute.  See
@@ -260,20 +260,21 @@ strings, and so forth).
    # the JSON value returned by ``objects`` will be:
    #    [{"x": 1}, {"x": 2}]
 
-.. note::
+If you don't own the objects being serialized, it's difficult to add a custom
+``__json__`` method to the object. In this case, a callback can be supplied
+to the renderer which is invoked when other options have failed.
 
-   Honoring the ``__json__`` method of custom objects is a feature new in
-   Pyramid 1.4.
+.. code-block:: python
+   :linenos:
+
+   def default(obj):
+       if isinstance(obj, datetime.datetime):
+           return obj.isoformat()
+       raise TypeError
 
-.. warning::
+.. note::
 
-   The machinery which performs the ``__json__`` method-calling magic is in
-   the :class:`pyramid.renderers.ObjectJSONEncoder` class.  This class will
-   be used for encoding any non-basic Python object when you use the default
-   ```json`` or ``jsonp`` renderers.  But if you later define your own custom
-   JSON renderer and pass it a "cls" argument signifying a different encoder,
-   the encoder you pass will override Pyramid's use of
-   :class:`pyramid.renderers.ObjectJSONEncoder`.
+   Serializing custom objects is a feature new in Pyramid 1.4.
 
 .. index::
    pair: renderer; JSONP
-- 
cgit v1.2.3