Update UID docstring to make it less OS-specific

Crozzers · Oct 13, 2024 · 234d790 · 234d790
1 parent 05ad0c0
commit 234d790
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 6 deletions.
diff --git 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
@@ -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
 '''