Skip to content

Commit 4a6d251

Browse files
fix: add missing experiment helper docstrings
1 parent 1187c34 commit 4a6d251

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

lms/djangoapps/experiments/audit_expiry_urgency.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,19 @@ def _get_attribute(enrollment, name):
8686

8787

8888
def get_persisted_variant(enrollment):
89+
"""Return the persisted experiment variant for an enrollment, if present."""
8990
attr = _get_attribute(enrollment, ATTRIBUTE_NAME_VARIANT)
9091
return attr.value if attr else None
9192

9293

9394
def get_persisted_experiment_key(enrollment):
95+
"""Return the persisted experiment key for an enrollment, if present."""
9496
attr = _get_attribute(enrollment, ATTRIBUTE_NAME_EXPERIMENT_KEY)
9597
return attr.value if attr else None
9698

9799

98100
def get_persisted_expiry_days(enrollment):
101+
"""Return the persisted expiry-days value as an int, if valid."""
99102
attr = _get_attribute(enrollment, ATTRIBUTE_NAME_EXPIRY_DAYS)
100103
if not attr:
101104
return None
@@ -106,16 +109,19 @@ def get_persisted_expiry_days(enrollment):
106109

107110

108111
def get_persisted_assigned_at(enrollment):
112+
"""Return the persisted assignment timestamp for an enrollment, if present."""
109113
attr = _get_attribute(enrollment, ATTRIBUTE_NAME_ASSIGNED_AT)
110114
return attr.value if attr else None
111115

112116

113117
def get_persisted_decision_source(enrollment):
118+
"""Return how the persisted experiment decision was made, if present."""
114119
attr = _get_attribute(enrollment, ATTRIBUTE_NAME_DECISION_SOURCE)
115120
return attr.value if attr else None
116121

117122

118123
def get_persisted_audit_expiry_at(enrollment):
124+
"""Return the persisted audit expiry datetime string for an enrollment, if present."""
119125
attr = _get_attribute(enrollment, ATTRIBUTE_NAME_AUDIT_EXPIRY_AT)
120126
return attr.value if attr else None
121127

0 commit comments

Comments
 (0)