diff --git a/src/ska_tango_base/base/admin_mode_model.py b/src/ska_tango_base/base/admin_mode_model.py index 598228db191d489a0de89de22bdadfd62c3f47a5..ba70d88f3f8193dca6d25b80e0c01084cbca1103 100644 --- a/src/ska_tango_base/base/admin_mode_model.py +++ b/src/ska_tango_base/base/admin_mode_model.py @@ -1,8 +1,7 @@ """ This module specifies the admin mode model for SKA LMC Tango devices. -It -consists of a single public class: :py:class:`.AdminModeModel`. This +It consists of a single public class: :py:class:`.AdminModeModel`. This uses a state machine to device device adminMode, represented as a :py:class:`ska_tango_base.control_model.AdminMode` enum value, and reported by Tango devices through the ``AdminMode`` attribute. @@ -180,8 +179,7 @@ class AdminModeModel: This is a helper method that updates admin mode, ensuring that the callback is called if one exists. - :param machine_state: the new state of the observation state - machine + :param machine_state: the new state of the admin mode machine :type machine_state: str """ admin_mode = AdminMode[machine_state] diff --git a/src/ska_tango_base/base/base_device.py b/src/ska_tango_base/base/base_device.py index 28321e604ed3d1b70a9e87b12c65b8c5addec33b..83ce85a3d327a51793d95451f3ed82965f63943b 100644 --- a/src/ska_tango_base/base/base_device.py +++ b/src/ska_tango_base/base/base_device.py @@ -737,7 +737,7 @@ class SKABaseDevice(Device): """ Initialise the tango device after startup. - Subclasses that have no need to override the default default + Subclasses that have no need to override the default implementation of state management may leave ``init_device()`` alone. Override the ``do()`` method on the nested class ``InitCommand`` instead. @@ -775,7 +775,7 @@ class SKABaseDevice(Device): def register_command_object(self, command_name, command_object): """ - Register a object as a handler for a command. + Register an object as a handler for a command. :param command_name: name of the command for which the object is being registered diff --git a/src/ska_tango_base/base/op_state_model.py b/src/ska_tango_base/base/op_state_model.py index cdcba3642ed733c460e1d6391774a32440d68717..c9e86888ed090c647e0302dc53fb7c563aa25333 100644 --- a/src/ska_tango_base/base/op_state_model.py +++ b/src/ska_tango_base/base/op_state_model.py @@ -408,7 +408,7 @@ class OpStateModel: This is a helper method that updates op_state, ensuring that the callback is called if one exists. - :param machine_state: the new state of the observation state + :param machine_state: the new state of the operation state machine :type machine_state: str """ diff --git a/src/ska_tango_base/base/reference_component_manager.py b/src/ska_tango_base/base/reference_component_manager.py index efe9e589b8a8e26c5daf90e2b211424eb060d684..065a348bd38821aa72c3006ecfe63b5322a4221a 100644 --- a/src/ska_tango_base/base/reference_component_manager.py +++ b/src/ska_tango_base/base/reference_component_manager.py @@ -39,7 +39,7 @@ def check_communicating(func): This is a wrapper function that implements the functionality of the decorator. - :param component: the component to check + :param component_manager: the component manager to check :param args: positional arguments to the wrapped function :param kwargs: keyword arguments to the wrapped function @@ -207,9 +207,9 @@ class ReferenceBaseComponentManager(BaseComponentManager): This helper method will also ensure that callbacks are called as required. - :param configured: new value for whether the component is - configured or not - :type configured: bool + :param power_mode: new value for the power mode + :type power_mode: + :py:class:`ska_tango_base.control_model.PowerMode` """ if self._power_mode != power_mode: self._power_mode = power_mode diff --git a/src/ska_tango_base/subarray/reference_component_manager.py b/src/ska_tango_base/subarray/reference_component_manager.py index 497170c009d434135e931f2843dd32fe2d7ad5a4..a878aadc2f5bb6afe055abfb567519d77cd400d5 100644 --- a/src/ska_tango_base/subarray/reference_component_manager.py +++ b/src/ska_tango_base/subarray/reference_component_manager.py @@ -569,8 +569,8 @@ class ReferenceSubarrayComponentManager( """ Tell the component to restart. - It will return to a state in which it is is unconfigured and - empty of assigned resources. + It will return to a state in which it is unconfigured and empty + of assigned resources. """ self.logger.info("Restarting component") if self._component.configured: diff --git a/src/ska_tango_base/subarray/subarray_device.py b/src/ska_tango_base/subarray/subarray_device.py index 5e4594678876dae5d93350ed573149c37eb8efcf..a093e8f3cac0965f1ba0d8253e49784a33580f7d 100644 --- a/src/ska_tango_base/subarray/subarray_device.py +++ b/src/ska_tango_base/subarray/subarray_device.py @@ -159,7 +159,7 @@ class SKASubarray(SKAObsDevice): def __init__(self, target, op_state_model, obs_state_model, logger=None): """ - Initialise a new ReleaseResourcesCommand instance. + Initialise a new ReleaseAllResourcesCommand instance. :param target: the object that this command acts upon; for example, the device's component manager diff --git a/tests/test_base_device.py b/tests/test_base_device.py index 8aa55f9e805aaabe1492ad67f1bf84ca8f31c5bc..2f1847ef3dec516b02558ed004b6e69634af76d2 100644 --- a/tests/test_base_device.py +++ b/tests/test_base_device.py @@ -690,7 +690,7 @@ class TestSKABaseDevice(object): @pytest.fixture() def patch_debugger_to_start_on_ephemeral_port(): """ - Patch the debugger to that it starts on an ephemeral port. + Patch the debugger so that it starts on an ephemeral port. This is necessary because of intermittent debugger test failures: if the previous test has used the debugger port, then when the test