add docstring

This commit is contained in:
Job Evers-Meltzer 2016-12-21 10:53:55 -08:00
parent 101985ca11
commit 52010ade41

View file

@ -18,6 +18,15 @@ def get_sd_hash(stream_info):
class Events(object): class Events(object):
def __init__(self, context, lbryid, session_id): 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.context = context
self.lbryid = lbryid self.lbryid = lbryid
self.session_id = session_id self.session_id = session_id