From b5cc57cee754d42d75ee9a07db2d5f9b9dd5e02f Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Tue, 12 Mar 2019 08:37:41 -0500 Subject: [PATCH] #91 DOC --- apstools/plans.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/apstools/plans.py b/apstools/plans.py index 0e301c6ce..33d848a2d 100644 --- a/apstools/plans.py +++ b/apstools/plans.py @@ -296,12 +296,14 @@ def sscan_step_1D(sscan, _md={}): assumes the sscan record has already been setup properly for a scan - EXAMPLE:: + EXAMPLE + + Assume that the chosen sscan record has already been setup. from apstools.devices import sscanDevice - from apstools.plans import sscan_step_1D scans = sscanDevice(P, name="scans") - # assume ready setup for this 1-D scan + + from apstools.plans import sscan_step_1D RE(sscan_step_1D(scans.scan1), md=dict(purpose="demo")) """