Skip to content

Commit b7eec96

Browse files
fix: Add proper docstring formatting with :param and :return: style
- Address GitHub comment about missing docstring format - Follow Python conventions for function documentation Co-Authored-By: jbailey@launchdarkly.com <accounts@sidewaysgravity.com>
1 parent 5891f34 commit b7eec96

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

ldclient/impl/util.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ def validate_application_value(value: Any, name: str, logger: logging.Logger) ->
5656
def is_valid_sdk_key_format(sdk_key: str) -> bool:
5757
"""
5858
Validates that a string does not contain invalid characters and is not too long for our systems.
59-
Returns True if the SDK key format is valid, otherwise False.
59+
60+
:param sdk_key: the SDK key to validate
61+
:return: True if the SDK key format is valid, otherwise False
6062
"""
6163
if sdk_key is None or sdk_key == '':
6264
return True

0 commit comments

Comments
 (0)