Skip to content

Commit

Permalink
#91 DOC
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Mar 12, 2019
1 parent 77411a3 commit b5cc57c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions apstools/plans.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
"""
Expand Down

0 comments on commit b5cc57c

Please sign in to comment.