summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-03-27 15:00:17 +0000
committerMichael Williamson <mike@zwobble.org>2014-03-27 15:00:17 +0000
commit5c28a95722cb748521199afe3200b66fa6a72b68 (patch)
tree9cb30739084e4834d322cfcce9477c35e0fa940c
parent30236682bfe220c79c4fdc0bea66f2f0e06f1fd4 (diff)
Document text_output when there are multiple output elements
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index d1d51e6..b3e347e 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,14 @@ The `text_output` argument can be used to serialise the output into JSON text:
jq(".").transform("42", text_output=True) == '"42"'
```
+If there are multiple output elements,
+each element is represented by a separate line,
+irrespective of the value of `multiple_output`:
+
+```python
+jq(".[]").transform("[1, 2, 3]", text_output=True) == "1\n2\n3"
+```
+
The `multiple_output` argument can be used for cases when multiple output elements are expected:
```python