docs: documented escape_lists

Author: umarbutler

README.md

@@ -76,6 +76,7 @@ output = text2markdown(
     strike_junk=True,
     block_quotes=True,
     italicize_refs=True,
+    escape_lists=True,
     enrichment_model="kanon-2-enricher",
     isaacus_client=Isaacus(),
 )

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "text2markdown"
-version = "0.1.0"
+version = "0.1.1"
 authors = [{ name = "Isaacus", email = "support@isaacus.com" }]
 description = "A Python library for intelligently converting text into Markdown."
 readme = "README.md"

src/text2markdown/async_text2markdown.py

@@ -30,7 +30,7 @@ async def text2markdown_async(
 
         block_quotes (bool, optional): Whether to transform non-inline quotes into Markdown block quotes.
 
-        escape_lists (bool, optional): Whether to escape list-like lines (lines starting with "-", "*", "+", or numbered lists). This leads to nicer rendering at the cost of cleaner Markdown source code.
+        escape_lists (bool, optional): Whether to escape list-like lines (lines starting with "-", "*", "+", or numbered lists).
 
         italicize_refs (bool, optional): Whether to italicize the names of any referenced documents, for example, "as mentioned in *Smith v. Jones*".
 

src/text2markdown/text2markdown.py

@@ -220,7 +220,7 @@ def text2markdown(
 
         block_quotes (bool, optional): Whether to transform non-inline quotes into Markdown block quotes.
 
-        escape_lists (bool, optional): Whether to escape list-like lines (lines starting with "-", "*", "+", or numbered lists). This leads to nicer rendering at the cost of cleaner Markdown source code.
+        escape_lists (bool, optional): Whether to escape list-like lines (lines starting with "-", "*", "+", or numbered lists).
 
         italicize_refs (bool, optional): Whether to italicize the names of any referenced documents, for example, "as mentioned in *Smith v. Jones*".