From 6e46ac0e384c3aa13fee71f1c722d4a14284bef5 Mon Sep 17 00:00:00 2001
From: Han Lu <11597940+ErbB4@users.noreply.github.com>
Date: Thu, 1 Aug 2024 08:13:06 +0200
Subject: [PATCH] fixed typo and code (#2345)

<!-- Please make sure your PR follows our [contribution
guidelines](https://github.com/arbor-sim/arbor/tree/master/doc/contrib)
and agree to the terms outlined in the [PR
procedure](https://github.com/arbor-sim/arbor/tree/master/doc/contrib/pr.rst).
-->

---------

Co-authored-by: Thorsten Hater <24411438+thorstenhater@users.noreply.github.com>
---
 doc/python/probe_sample.rst | 46 ++++++++++++++++++-------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/doc/python/probe_sample.rst b/doc/python/probe_sample.rst
index 107080af79..a5adf4f193 100644
--- a/doc/python/probe_sample.rst
+++ b/doc/python/probe_sample.rst
@@ -14,7 +14,7 @@ Cable cell probing and sampling
     A probeset is a probe placed on a locset (which may describe more than one point). 
     When setting a probe on a locset a :term:`sampler` is created.
     When this sampler is set to sampling (at a certain schedule), a handle is returned.
-    This figure demonstrates how sampling data can be accessed through the handle associated to the probeset.
+    This figure demonstrates how sampling data can be accessed through the handle associated with the probeset.
     See below for a possible result for ``data``.
 
 .. code-block:: python
@@ -32,7 +32,7 @@ columns holding the corresponding scalar- or vector-valued sample.
 
 Probesets are defined over a location expression and will describe zero,
 one, or more probes, one per site. They are evaluated in the context of
-the cell on which the probe is attached.
+the cell to which the probe is attached.
 
 :term:`Vector probes <vector probe>` are a kind of probes that samples over a region, rather than a :term:`locset`.
 This means that they may output more than a single data point per timestamp. The layout of the outputs as returned
@@ -67,49 +67,49 @@ Example
 
 .. code-block:: python
    
-   import arbor
+   import arbor as A
 
-   tree = arbor.segment_tree()
-   p = tree.append(arbor.mnpos, arbor.mpoint(-3, 0, 0, 3), arbor.mpoint(3, 0, 0, 3), tag=1)
-   tree.append(p, arbor.mpoint(3, 0, 0, 3), arbor.mpoint(-3, 0, 0, 3), tag=2)
-   tree.append(p, arbor.mpoint(3, 0, 0, 3), arbor.mpoint(-3, 0, 0, 3), tag=2)
+   tree = A.segment_tree()
+   p = tree.append(A.mnpos, A.mpoint(-3, 0, 0, 3), A.mpoint(3, 0, 0, 3), tag=1)
+   tree.append(p, A.mpoint(3, 0, 0, 3), A.mpoint(-3, 0, 0, 3), tag=2)
+   tree.append(p, A.mpoint(3, 0, 0, 3), A.mpoint(-3, 0, 0, 3), tag=2)
 
    decor = (
-      arbor.decor()
+      A.decor()
       .set_property(Vm=-40)
-      .paint('"soma"', arbor.density("hh"))
-      .place('"midpoint"', arbor.iclamp(10, 2, 0.8), "iclamp"))
+      .paint('"soma"', A.density("hh"))
+      .place('"midpoint"', A.iclamp(10*U.ms, 2*U.ms, 0.8*U.nA), "iclamp"))
 
-   cell = arbor.cable_cell(tree, decor)
+   cell = A.cable_cell(tree, decor)
 
-   class single_recipe(arbor.recipe):
+   class single_recipe(A.recipe):
       def __init__(self):
-         arbor.recipe.__init__(self)
+         A.recipe.__init__(self)
 
       def num_cells(self):
          return 1
 
       def cell_kind(self, gid):
-         return arbor.cell_kind.cable
+         return A.cell_kind.cable
 
       def cell_description(self, gid):
          return cell
 
       def probes(self, gid):
-         return [arbor.cable_probe_membrane_voltage('(location 0 0.5)'),
-                  arbor.cable_probe_membrane_voltage_cell(),
-                  arbor.cable_probe_membrane_voltage('(join (location 0 0) (location 0 1))'),
+         return [A.cable_probe_membrane_voltage('(location 0 0.5)'),
+                 A.cable_probe_membrane_voltage_cell(),
+                 A.cable_probe_membrane_voltage('(join (location 0 0) (location 0 1))'),
                   ]
 
       # (4.6) Override the global_properties method
       def global_properties(self, kind):
-         return arbor.neuron_cable_properties()
+         return A.neuron_cable_properties()
 
    recipe = single_recipe()
-   sim = arbor.simulation(recipe)
-   handles = [sim.sample((0, n), arbor.regular_schedule(0.1))
+   sim = A.simulation(recipe)
+   handles = [sim.sample((0, n), A.regular_schedule(0.1*U.ms))
             for n in range(3) ]
-   sim.run(tfinal=1)
+   sim.run(tfinal=1*U.ms)
 
    for hd in handles:
       print("Handle", hd)
@@ -117,7 +117,7 @@ Example
          print(" * Meta:", m)
          print(" * Payload:", d.shape)
 
-This script, has a single (scalar) probe, a single vector probe, and a probeset involving two scalar probes.
+This script has a single (scalar) probe, a single vector probe, and a probeset involving two scalar probes.
 The script is complete and can be run with Arbor installed, and will output:
 
 .. code-block::
@@ -275,7 +275,7 @@ Ionic internal concentration
 
    .. py:function:: cable_probe_ion_int_concentration_cell(ion)
 
-   Ionic internal concentration (mmol/L) of the given ``ion`` in each able in each
+   Ionic internal concentration (mmol/L) of the given ``ion`` in each cable in each
    CV of the cell discretization.
 
    Metadata: the list of corresponding :class:`cable` objects.