docs: Update docstrings to indicate some parameters aren't used in ce…

…rtain devices
tektronix · Oct 31, 2024 · 6a47c0d · 6a47c0d
1 parent a1734c3
commit 6a47c0d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 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
@@ -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
@@ -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.