Fix MyPlexPinLogin doc strings (#1336)

This commit is contained in:
JonnyWong16 2024-02-04 10:52:51 -08:00 committed by GitHub
parent 654ed506f4
commit dfc54718d1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1704,7 +1704,9 @@ class MyPlexPinLogin:
@property
def pin(self):
""" Return the 4 character PIN used for linking a device at https://plex.tv/link. """
""" Return the 4 character PIN used for linking a device at
https://plex.tv/link.
"""
if self._oauth:
raise BadRequest('Cannot use PIN for Plex OAuth login')
return self._code
@ -1736,6 +1738,7 @@ class MyPlexPinLogin:
def run(self, callback=None, timeout=None):
""" Starts the thread which monitors the PIN login state.
Parameters:
callback (Callable[str]): Callback called with the received authentication token (optional).
timeout (int): Timeout in seconds waiting for the PIN login to succeed (optional).
@ -1758,6 +1761,7 @@ class MyPlexPinLogin:
def waitForLogin(self):
""" Waits for the PIN login to succeed or expire.
Parameters:
callback (Callable[str]): Callback called with the received authentication token (optional).
timeout (int): Timeout in seconds waiting for the PIN login to succeed (optional).