Skip to content

Commit 359d048

Browse files
committed
syling magbead examples and explanation
1 parent b7983e3 commit 359d048

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

docs/source/module.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Just like a pipette, you need to set up and name your module.
2020

2121
**instruments.Magbead** (*mofset, name*)
2222

23-
* **mofset -** default to =0
23+
* **mosfet -** integer 0-5 (defaults to 0)
2424
* **name -** the name you want to call your module
2525

2626
.. testsetup:: main
@@ -31,23 +31,20 @@ Just like a pipette, you need to set up and name your module.
3131

3232
.. testcode:: main
3333

34-
mag_deck = instruments.Magbead(
35-
mosfet=0,
36-
name='mag_deck'
37-
)
34+
mag_deck = instruments.Magbead(name='mag_deck')
3835

3936
Activate and Deactivate Magnets
4037
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4138

42-
To activate the magnets, use the following command
39+
To activate the magnets and raise the module's platform, run ``.engage()``:
4340

4441
**module.engage** ()
4542

4643
.. testcode:: main
4744

4845
mag_deck.engage()
4946

50-
To deactive the magnets, use the following command
47+
To deactivate the magnets and lower the module's platform, run ``.disengage()``:
5148

5249
**module.disengage** ()
5350

@@ -58,7 +55,7 @@ To deactive the magnets, use the following command
5855
Chain Other Commands
5956
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6057

61-
Just like aspirate() and dispense() can be chained, you can chain engage() and disengage(), as well as the delay() if you don't want to do anything between engaging and disengaging the magnets.
58+
Just like ``aspirate()`` and ``dispense()`` can be chained, you can chain ``engage()`` and ``disengage()``, as well as the ``delay()`` if you don't want to do anything between engaging and disengaging the magnets.
6259

6360
.. testcode:: main
6461

@@ -68,7 +65,7 @@ Just like aspirate() and dispense() can be chained, you can chain engage() and d
6865

6966
mag_deck.engage().delay(60).disengage()
7067

71-
You can call delay() with a pipette or a mag_deck module.
68+
You can call ``delay()`` with a ``Pipette`` or a ``Magbead`` module.
7269

7370
.. testcode:: main
7471

0 commit comments

Comments
 (0)