From 234d7907152eed9baf6021f895843a6b3e75507d Mon Sep 17 00:00:00 2001 From: Crozzers Date: Sun, 13 Oct 2024 19:05:04 +0100 Subject: [PATCH] Update UID docstring to make it less OS-specific --- screen_brightness_control/__init__.py | 7 ++----- screen_brightness_control/types.py | 2 +- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/screen_brightness_control/__init__.py b/screen_brightness_control/__init__.py index accd101..69c9b1c 100644 --- a/screen_brightness_control/__init__.py +++ b/screen_brightness_control/__init__.py @@ -265,10 +265,7 @@ def list_monitors_info( print('Method:', display['method']) # the EDID string associated with that display print('EDID:', display['edid']) - # The UID of the display. - # On Windows, this identifier is derived from the InstanceName (WMI) or DeviceID (win32api), - # and represents the connection details (e.g., port, path) rather than the physical display itself. - # It changes if the display is connected to a different port or system. + # The UID of the display print('UID:', display['uid']) ``` ''' @@ -350,7 +347,7 @@ class Display(): This will be a class from either the windows or linux sub-module''' uid: Optional[str] = None - """'UID for the display connection, extracted from InstanceName (WMI) or DeviceID (win32api) on Windows.""" + '''A unique identifier for the display. This is usually inferred from the display's connection to the machine.''' edid: Optional[str] = None '''A 256 character hex string containing information about a display and its capabilities''' manufacturer: Optional[str] = None diff --git a/screen_brightness_control/types.py b/screen_brightness_control/types.py index 9b4f41d..582db70 100644 --- a/screen_brightness_control/types.py +++ b/screen_brightness_control/types.py @@ -49,5 +49,5 @@ - name (str) - index (int) -See `Display` for descriptions of each property and its type +See `.Display` for descriptions of each property and its type '''