Mention gotcha prevention among features (#83)

wbolster · Sep 1, 2023 · f2a623e · f2a623e
1 parent 0b10645
commit f2a623e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -54,6 +54,13 @@ 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
 ============