From 6a47c0d2ece36e4c8344781db8360e2f1f0d11ae Mon Sep 17 00:00:00 2001 From: "Felt, Nicholas" Date: Thu, 31 Oct 2024 12:59:38 -0700 Subject: [PATCH] docs: Update docstrings to indicate some parameters aren't used in certain devices --- .../abstract_device_functionality/screen_capture_mixin.py | 4 ++-- src/tm_devices/drivers/scopes/tekscope/tekscope.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/tm_devices/driver_mixins/abstract_device_functionality/screen_capture_mixin.py b/src/tm_devices/driver_mixins/abstract_device_functionality/screen_capture_mixin.py index b99c62a6..e913ccd5 100644 --- a/src/tm_devices/driver_mixins/abstract_device_functionality/screen_capture_mixin.py +++ b/src/tm_devices/driver_mixins/abstract_device_functionality/screen_capture_mixin.py @@ -40,8 +40,8 @@ def save_screenshot( Args: filename: The name of the file to save the screenshot as. - colors: The color scheme to use for the screenshot. - view_type: The type of view to capture. + colors: The color scheme to use for the screenshot. (Not used by all devices) + view_type: The type of view to capture. (Not used by all devices) local_folder: The local folder to save the screenshot in. Defaults to "./". device_folder: The folder on the device to save the screenshot in. Defaults to "./". keep_device_file: Whether to keep the file on the device after downloading it. diff --git a/src/tm_devices/drivers/scopes/tekscope/tekscope.py b/src/tm_devices/drivers/scopes/tekscope/tekscope.py index 9af13229..24f6cb33 100644 --- a/src/tm_devices/drivers/scopes/tekscope/tekscope.py +++ b/src/tm_devices/drivers/scopes/tekscope/tekscope.py @@ -713,7 +713,7 @@ def _save_screenshot( Args: filename: The name of the file to save the screenshot as. colors: The color scheme to use for the screenshot. - view_type: The type of view to capture. + view_type: The type of view to capture. (Not used in any TekScope drivers) local_folder: The local folder to save the screenshot in. Defaults to "./". device_folder: The folder on the device to save the screenshot in. Defaults to "./". keep_device_file: Whether to keep the file on the device after downloading it.