Skip to content

Commit dab7989

Browse files
committed
DOC #178 almost done
1 parent cc11758 commit dab7989

File tree

3 files changed

+772
-9
lines changed

3 files changed

+772
-9
lines changed

docs/source/examples/_run_command_list.rst

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -244,25 +244,45 @@ To test our command file, run it through the
244244
bluesky.simulators.summarize_plan(run_command_file("sample_example.txt"))
245245

246246
The output will be rather lengthy, if there are no errors.
247+
Here are the first few lines:
247248

248-
.. warning: FIXME:
249-
250-
Issue must be corrected before this documentation is complete.
251-
https://github.com/BCDA-APS/apstools/issues/185
249+
.. literalinclude:: ../resources/sample_example_summary.txt
250+
:tab-width: 4
251+
:language: guess
252+
:lines: 1-20
253+
254+
and the last few lines:
255+
256+
.. literalinclude:: ../resources/sample_example_summary.txt
257+
:tab-width: 4
258+
:language: guess
259+
:lines: 728-
252260

253261
.. _command_file_running:
254262

255263
Running the command file
256264
++++++++++++++++++++++++
257265

258-
::
266+
To run the command file, you need to pass this to an instance of the
267+
:class:`bluesky.RunEngine`, usually defined as ``RE``, such as::
259268

260269
RE(apstools.plans.run_command_file("sample_example.txt"))
261270

262-
.. warning: FIXME:
263-
264-
Issue must be corrected before this documentation is complete.
265-
https://github.com/BCDA-APS/apstools/issues/185
271+
The output will be rather lengthy, if there are no errors.
272+
Here are the first few lines:
273+
274+
.. TODO:
275+
.. literalinclude:: ../resources/sample_example_run.txt
276+
:tab-width: 4
277+
:language: guess
278+
:lines: 1-20
279+
280+
and the last few lines:
281+
282+
.. literalinclude:: ../resources/sample_example_run.txt
283+
:tab-width: 4
284+
:language: guess
285+
:lines: ???
266286
267287
.. _command_file_other_spreadsheets:
268288

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
output from the RunEngine

0 commit comments

Comments
 (0)