DOC #940

BCDA-APS · Mar 17, 2024 · 8f51717 · 8f51717
1 parent 80cbb5c
commit 8f51717
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/docs/source/examples/pl_sscan.ipynb b/docs/source/examples/pl_sscan.ipynb
@@ -49,7 +49,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Example 1 -- Press SCAN button of a preconfigured scan\n",
+    "## 1. Press SCAN button of a preconfigured scan\n",
     "\n",
     "Consider the case where the `sscan` record is already configured with all the\n",
     "parameters necessary to perform a complete step scan.\n",
@@ -102,6 +102,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "### 1.A. wait with a polling loop\n",
+    "\n",
     "Write a bluesky plan that pushes the button, waits a brief moment for the scan\n",
     "to start, then waits for the scan to end.  This simple example waits by\n",
     "periodically polling the value of the button.\n",
@@ -167,6 +169,8 @@
    "source": [
     "To get the data from the `sscan` record, we use `ophyd.EpicsSignalRO` to connect with the arrays.  We'll do that in a later section of this notebook.\n",
     "\n",
+    "### 1.B. wait with a Status object\n",
+    "\n",
     "Let's eliminate that polling loop.  This will make the plan respond more quickly\n",
     "when the button changes value.  The `ophyd.status.Status` class (runs in the\n",
     "background) reports when the scan has finished or times out.  We define an inner\n",
@@ -221,7 +225,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Example 2 -- Run preconfigured `sscan` record\n",
+    "## 2. Run preconfigured `sscan` record\n",
     "\n",
     "The `apstools.synApps.SscanRecord` class provides access to most of the fields\n",
     "provided by a `sscan` record.  Use `SscanRecord` to connect and repeat the above\n",
@@ -323,7 +327,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Example 3 -- Setup and run same scan from bluesky\n",
+    "## 3. Setup and run same scan from bluesky\n",
     "\n",
     "Repeat the scan from the previous examples, but use bluesky to configure\n",
     "`scan1`.  It will be useful to connect the motor, the scaler, and two the scaler\n",
@@ -482,7 +486,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Post data to bluesky as a run\n",
+    "## 4. Post data to bluesky as a run\n",
     "\n",
     "So far, we have just run `scan1` and shown the data collected.  We'll need to do\n",
     "a bit more work to get this data into bluesky as a run.  While we might just use\n",