Skip to content

Commit 2efcc70

Browse files
committed
MNT: Upadte docstring
1 parent b72cb21 commit 2efcc70

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

bluesky-tiled-plugins/bluesky_tiled_plugins/exporters.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,26 @@
44

55

66
async def json_seq_exporter(mimetype, adapter, metadata, filter_for_access):
7-
"""
8-
Export BlueskyRun is newline-delimited sequence of JSON.
7+
"""Export BlueskyRun as newline-delimited sequence of JSON documents.
8+
9+
This callback is to be configured on the server-side to enable exporting
10+
BlueskyRun objects in JSON-Seq format.
911
10-
Format is like:
12+
The resulting stream yields strings, each of which is a JSON document
13+
representing one of the standard Bluesky documents: start, descriptor,
14+
event, stream_resource, stream_datum, and stop, in the appropriate order.
15+
16+
For example:
1117
18+
```
1219
{"name": "start", "doc": {...}}
1320
{"name": "descriptor", "doc": {...}}
21+
{"name": "event", "doc": {...}}
22+
{"name": "stream_resource", "doc": {...}}
23+
{"name": "stream_datum", "doc": {...}}
1424
...
25+
{"name": "stop", "doc": {...}}
26+
```
1527
"""
1628
for spec in adapter.specs:
1729
if spec.name == "BlueskyRun" and spec.version.startswith("3."):

0 commit comments

Comments
 (0)