Skip to content

Commit 234d790

Browse files
committed
Update UID docstring to make it less OS-specific
1 parent 05ad0c0 commit 234d790

File tree

2 files changed

+3
-6
lines changed

2 files changed

+3
-6
lines changed

screen_brightness_control/__init__.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,7 @@ def list_monitors_info(
265265
print('Method:', display['method'])
266266
# the EDID string associated with that display
267267
print('EDID:', display['edid'])
268-
# The UID of the display.
269-
# On Windows, this identifier is derived from the InstanceName (WMI) or DeviceID (win32api),
270-
# and represents the connection details (e.g., port, path) rather than the physical display itself.
271-
# It changes if the display is connected to a different port or system.
268+
# The UID of the display
272269
print('UID:', display['uid'])
273270
```
274271
'''
@@ -350,7 +347,7 @@ class Display():
350347
This will be a class from either the windows or linux sub-module'''
351348

352349
uid: Optional[str] = None
353-
"""'UID for the display connection, extracted from InstanceName (WMI) or DeviceID (win32api) on Windows."""
350+
'''A unique identifier for the display. This is usually inferred from the display's connection to the machine.'''
354351
edid: Optional[str] = None
355352
'''A 256 character hex string containing information about a display and its capabilities'''
356353
manufacturer: Optional[str] = None

screen_brightness_control/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@
4949
- name (str)
5050
- index (int)
5151
52-
See `Display` for descriptions of each property and its type
52+
See `.Display` for descriptions of each property and its type
5353
'''

0 commit comments

Comments
 (0)