docs(api): MagneticBlockContext in API reference (#13136)

Opentrons · Jul 20, 2023 · 44bcbed · 44bcbed
1 parent 8efc586
commit 44bcbed
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 12 deletions.
diff --git a/api/docs/v2/new_modules.rst b/api/docs/v2/new_modules.rst
@@ -37,7 +37,7 @@ When you load a module in a protocol, you inform the OT-2 that you want the spec
 
 .. versionadded:: 2.0
 
-.. _available_modules
+.. _available_modules:
 
 Available Modules
 -----------------

diff --git a/api/docs/v2/new_protocol_api.rst b/api/docs/v2/new_protocol_api.rst
@@ -42,26 +42,31 @@ Labware and Wells
 Modules
 -------
 
-.. autoclass:: opentrons.protocol_api.TemperatureModuleContext
+.. autoclass:: opentrons.protocol_api.HeaterShakerContext
    :members:
-   :exclude-members: start_set_temperature, await_temperature, broker, geometry, load_labware_object
+   :exclude-members: broker, geometry, load_labware_object
+   :inherited-members:
+
+.. autoclass:: opentrons.protocol_api.MagneticBlockContext
+   :members:
+   :exclude-members: broker, geometry, load_labware_object
    :inherited-members:
 
 .. autoclass:: opentrons.protocol_api.MagneticModuleContext
    :members:
    :exclude-members: calibrate, broker, geometry, load_labware_object
    :inherited-members:
 
+.. autoclass:: opentrons.protocol_api.TemperatureModuleContext
+   :members:
+   :exclude-members: start_set_temperature, await_temperature, broker, geometry, load_labware_object
+   :inherited-members:
+
 .. autoclass:: opentrons.protocol_api.ThermocyclerContext
    :members:
    :exclude-members: total_step_count, current_cycle_index, total_cycle_count, hold_time, ramp_rate, current_step_index, broker, geometry, load_labware_object
    :inherited-members:
 
-.. autoclass:: opentrons.protocol_api.HeaterShakerContext
-   :members:
-   :exclude-members: broker, geometry, load_labware_object
-   :inherited-members:
-
 
 .. _protocol-api-types:
 

diff --git a/api/src/opentrons/protocol_api/protocol_context.py b/api/src/opentrons/protocol_api/protocol_context.py
@@ -648,14 +648,18 @@ def load_module(
 
         :type location: str or int or None
         :returns: The loaded and initialized module---a
-                  :py:class:`TemperatureModuleContext`,
-                  :py:class:`MagneticModuleContext`,
-                  :py:class:`ThermocyclerContext`, or
                   :py:class:`HeaterShakerContext`,
+                  :py:class:`MagneticBlockContext`,
+                  :py:class:`MagneticModuleContext`,
+                  :py:class:`TemperatureModuleContext`, or
+                  :py:class:`ThermocyclerContext`,
                   depending on what you requested with ``module_name``.
 
+                  .. versionchanged:: 2.13
+                    Added ``HeaterShakerContext`` return value.
+
                   .. versionchanged:: 2.15
-                    Added :py:class:`MagneticBlockContext` return value.
+                    Added ``MagneticBlockContext`` return value.
         """
         if configuration:
             if self._api_version < APIVersion(2, 4):