From 52010ade4195ce2647ee24279aae46474d4e58db Mon Sep 17 00:00:00 2001 From: Job Evers-Meltzer Date: Wed, 21 Dec 2016 10:53:55 -0800 Subject: [PATCH] add docstring --- lbrynet/analytics/events.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lbrynet/analytics/events.py b/lbrynet/analytics/events.py index 6c32df98c..310ee1ce1 100644 --- a/lbrynet/analytics/events.py +++ b/lbrynet/analytics/events.py @@ -18,6 +18,15 @@ def get_sd_hash(stream_info): class Events(object): def __init__(self, context, lbryid, session_id): + """Contains all of the analytics events that can be sent + + Attributes: + context: usually the output of `make_context` + lbryid: id unique to this installation. Can be anything, but + generally should be base58 encoded. + session_id: id for tracking events during this session. Can be + anything, but generally should be base58 encoded. + """ self.context = context self.lbryid = lbryid self.session_id = session_id