Skip to content

Commit eca5193

Browse files
committed
Arg raises to docstring
1 parent 9f9bd39 commit eca5193

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

bittensor/utils/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,12 @@ def unlock_key(
343343
unlock_type: the key type, 'coldkey' or 'hotkey'
344344
raise_error: if False, will return (False, error msg), if True will raise the otherwise-caught exception.
345345
346-
Returns: UnlockStatus for success status of unlock, with error message if unsuccessful
346+
Returns:
347+
UnlockStatus for success status of unlock, with error message if unsuccessful
348+
349+
Raises:
350+
bittensor_wallet.errors.PasswordError: incorrect password
351+
bittensor_wallet.errors.KeyFileError: keyfile is corrupt, non-writable, or non-readable, or non-existent
347352
"""
348353
if unlock_type == "coldkey":
349354
unlocker = "unlock_coldkey"

0 commit comments

Comments
 (0)