Skip to content

Commit 52d6efc

Browse files
committed
docs: fix sourcelib argument docstring
1 parent d1b379b commit 52d6efc

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

openedx_events/data.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ class EventsMetadata:
4242
time (datetime): (optional) timestamp when the event was sent with
4343
UTC timezone. Defaults to current time in UTC. See OEP-41 for
4444
details.
45-
sourcelib (str): Open edX Events library version.
45+
sourcelib (tuple of ints): Open edX Events library version. A tuple was
46+
selected so that version comparisons don't have to worry about
47+
lexical ordering of strings (e.g. '0.9.0' vs. '0.10.0').
4648
"""
4749

4850
id = attr.ib(type=UUID, init=False)

0 commit comments

Comments
 (0)