Skip to content

Commit

Permalink
Modify docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Rose Yemelyanova committed Oct 23, 2023
1 parent 03a65ec commit ed2cae5
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/dls_bluesky_core/stubs/flyables.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,20 @@ def fly_and_collect(
checkpoint_every_collect: bool = False,
stream_name: str = "primary",
) -> MsgGenerator:
"""Repeatedly fly and collect a flyer, flushing with a period.
"""Fly and collect a flyer, waiting for collect to finish with a period.
flyer.kickoff and complete are called, which starts the fly scanning process.
bps.wait is called, which finishes after each flush period and then repeats, until
complete finishes. At this point, bps.collect is called to gather the documents
produced.
For some flyers, this plan will need to be called in succession in order to, for
example, set up a flyer to send triggers and collect data without pause. For such
example, set up a flyer to send triggers multiple times and collect data. For such
a use case, this plan can be setup to checkpoint for each collect.
Note: this plan must be wrapped with calls to open and close a run, and the flyer
must implement the Collectable protocol.
Note: this plan must be wrapped with calls to open and close run, and the flyer
must implement the Collectable protocol. See tests/stubs/test_flyables for an
example.
Args:
flyer (Flyable, Collectable): ophyd-async device which implements Flyable and
Expand Down

0 comments on commit ed2cae5

Please sign in to comment.