Skip to content

Commit 714411b

Browse files
committed
docs: Add examples to match_flag_dependency docstring
1 parent 025907c commit 714411b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

posthog/dependency_graph.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,31 @@ def match_flag_dependency(
227227
228228
Returns:
229229
bool: True if the flag result matches the filter value
230+
231+
Examples:
232+
>>> # Boolean True filter matches any enabled state
233+
>>> match_flag_dependency(True, True)
234+
True
235+
>>> match_flag_dependency(True, "variant-a")
236+
True
237+
>>> match_flag_dependency(True, False)
238+
False
239+
240+
>>> # Boolean False filter matches only disabled state
241+
>>> match_flag_dependency(False, False)
242+
True
243+
>>> match_flag_dependency(False, True)
244+
False
245+
>>> match_flag_dependency(False, "variant-a")
246+
False
247+
248+
>>> # String filter matches exact variant name
249+
>>> match_flag_dependency("variant-a", "variant-a")
250+
True
251+
>>> match_flag_dependency("variant-a", "variant-b")
252+
False
253+
>>> match_flag_dependency("variant-a", True)
254+
False
230255
"""
231256
if filter_value is True:
232257
# True matches any enabled state (not false)

0 commit comments

Comments
 (0)