Skip to content

Commit d221e8c

Browse files
committed
added docstring for OutputDelegate.output
1 parent 56677fd commit d221e8c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

piccolo/query/mixins.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,14 @@ def output(
176176
as_list: t.Optional[bool] = None,
177177
as_json: t.Optional[bool] = None,
178178
):
179+
"""
180+
:param as_list:
181+
If each row only returns a single value, compile all of the results
182+
into a single list.
183+
:param as_json:
184+
The results are serialised into JSON. It's equivalent to running
185+
`json.dumps` on the result.
186+
"""
179187
if as_list is not None:
180188
self._output.as_list = bool(as_list)
181189

0 commit comments

Comments
 (0)