Skip to content

Commit

Permalink
Use a definition list for the incompatibilities
Browse files Browse the repository at this point in the history
  • Loading branch information
lelit committed Aug 16, 2017
1 parent 18fbbdc commit 8605f6a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
17 changes: 9 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,14 @@ Incompatibility
Here are things in the standard ``json`` library supports that we have decided
not to support:

* ``separators`` argument. This is mostly used for pretty printing and not
supported by ``RapidJSON`` so it isn't a high priority. We do support
``indent`` kwarg that would get you nice looking JSON anyways.

* Coercing keys when dumping. ``json`` will turn ``True`` into ``'True'`` if
you dump it out but when you load it back in it'll still be a string. We
want the dump and load to return the exact same objects so we have decided
not to do this coercing.
``separators`` argument
This is mostly used for pretty printing and not supported by ``RapidJSON``
so it isn't a high priority. We do support ``indent`` kwarg that would get
you nice looking JSON anyways.

Coercing keys when dumping
``json`` will turn ``True`` into ``'True'`` if you dump it out but when you
load it back in it'll still be a string. We want the dump and load to return
the exact same objects so we have decided not to do this coercion.

.. _RapidJSON: https://github.com/miloyip/rapidjson
17 changes: 9 additions & 8 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,14 +117,15 @@ Incompatibilities
Here are things in the standard ``json`` library that we have decided not to
support:

* ``separators`` argument. This is mostly used for pretty printing and not
supported by RapidJSON_ so it isn't a high priority. We do support
``indent`` kwarg that would get you nice looking JSON anyways.

* Coercing keys when dumping. ``json`` will turn ``True`` into ``'True'`` if
you dump it out but when you load it back in it'll still be a string. We
want the dump and load to return the exact same objects so we have decided
not to do this coercing.
``separators`` argument
This is mostly used for pretty printing and not supported by RapidJSON_ so
it isn't a high priority. We do support ``indent`` kwarg that would get you
nice looking JSON anyways.

Coercing keys when dumping
``json`` will turn ``True`` into ``'True'`` if you dump it out but when you
load it back in it'll still be a string. We want the dump and load to return
the exact same objects so we have decided not to do this coercion.


.. _JSON: http://json.org/
Expand Down

0 comments on commit 8605f6a

Please sign in to comment.