From 5ec8fa590d98fbc22b05a7840c239dcef26ceba8 Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Mon, 10 Mar 2014 11:41:07 -0500 Subject: [PATCH] document FakeShutdownEvent --- speedtest_cli.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/speedtest_cli.py b/speedtest_cli.py index f8da8d6..68c619b 100755 --- a/speedtest_cli.py +++ b/speedtest_cli.py @@ -21,8 +21,14 @@ USER_AGENT = 'speedtest-cli/%s' % __version__ class FakeShutdownEvent(object): + """Class to fake a threading.Event.isSet so that users of this module + are not required to register their own threading.Event() + + """ + @staticmethod def isSet(): + "Dummy method to always return false""" return False