Mwalker has submitted this change and it was merged.

Change subject: Write an entire half-line of docstring for each class
......................................................................


Write an entire half-line of docstring for each class

Change-Id: I12802649ef1f564d5bdb5d19763c0dbeda62a75b
---
M brain.py
M irc.py
M job.py
M text.py
4 files changed, 7 insertions(+), 1 deletion(-)

Approvals:
  Mwalker: Verified; Looks good to me, approved



diff --git a/brain.py b/brain.py
index 6cae609..86a32e4 100644
--- a/brain.py
+++ b/brain.py
@@ -4,6 +4,8 @@
 from job import JobQueue
 
 class Brain(object):
+    """Respond to incoming commands"""
+
     def __init__(self, config, sink=None):
         self.config = config
         self.sink = sink
diff --git a/irc.py b/irc.py
index e066202..def1e4d 100644
--- a/irc.py
+++ b/irc.py
@@ -11,7 +11,7 @@
 
 class RelayToIRC(irc.IRCClient):
     """
-    Bot brain will spawn listening jobs and then relay results to an irc 
channel.
+    Wire bot brain, job queue, and config into a Twisted IRC client
     """
     timestamp = None
 
diff --git a/job.py b/job.py
index bd3951d..c358868 100644
--- a/job.py
+++ b/job.py
@@ -2,6 +2,8 @@
 import copy
 
 class JobQueue(object):
+    """Create and poll jobs"""
+
     threads = []
     jobs_def = []
 
diff --git a/text.py b/text.py
index ee0fabc..ce5bca2 100644
--- a/text.py
+++ b/text.py
@@ -1,3 +1,5 @@
+"""Helpers for text manipulation"""
+
 import re
 from HTMLParser import HTMLParser
 

-- 
To view, visit https://gerrit.wikimedia.org/r/135938
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I12802649ef1f564d5bdb5d19763c0dbeda62a75b
Gerrit-PatchSet: 1
Gerrit-Project: wikimedia/fundraising/slander
Gerrit-Branch: master
Gerrit-Owner: Awight <[email protected]>
Gerrit-Reviewer: Mwalker <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to