Skip to content

Commit

Permalink
expand feature list in docs (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
wbolster committed Sep 1, 2023
1 parent f2a623e commit 81b0cfa
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ using this format do not have to reinvent the wheel.
Features
========

* Sensible behaviour for most use cases

* transparently handles ``str`` and ``bytes``, both for input and output
* supports multiple JSON libraries, e.g. ``json`` (standard library), ``orjson``, ``ujson``
* transparently handles UTF-8 BOM (if present)
* useful error messages
* prevents gotchas, e.g. uses standard-compliant line breaking, unlike `str.splitlines`_

.. _str.splitlines: https://docs.python.org/3/library/stdtypes.html#str.splitlines

* Convenient :py:func:`~jsonlines.open()` function

* makes simple cases trivial to write
Expand Down Expand Up @@ -54,13 +64,6 @@ Features
* allows complete control over encoding using a custom ``dumps``
callable

.. _gotchas:

* Prevents gotchas when handling supported inputs

* uses standard-compliant line breaking, unlike `str.splitlines`_

.. _str.splitlines: https://docs.python.org/3/library/stdtypes.html#str.splitlines

Installation
============
Expand Down

0 comments on commit 81b0cfa

Please sign in to comment.