From 74862c5e685b7b6332476242560a19d7ff62331a Mon Sep 17 00:00:00 2001
From: Adam Williamson <awilliam@redhat.com>
Date: Mar 03 2016 03:32:59 +0000
Subject: pylint cleanups: release.py


---

diff --git a/wikitcms/release.py b/wikitcms/release.py
index 9da7408..57cb744 100644
--- a/wikitcms/release.py
+++ b/wikitcms/release.py
@@ -17,7 +17,7 @@
 #
 # Author: Adam Williamson <awilliam@redhat.com>
 
-# Classes that describe distribution releases are defined in this file.
+"""Classes that describe distribution releases are defined here."""
 
 from __future__ import unicode_literals
 from __future__ import print_function
@@ -26,23 +26,29 @@ from . import page as pg
 from . import listing as li
 
 class Release(object):
-    """Class for a Fedora release. site is an mwclient site object. Release
-    is a string containing a Fedora release version (e.g. 21).
+    """Class for a Fedora release. wiki is a wikitcms site object.
+    Release is a string containing a Fedora release version (e.g. 21).
     """
-
     def __init__(self, release, wiki):
         self.release = release
-        self.category_name = ("Category:Fedora {0} Test Results").format(
-                self.release)
+        self.category_name = "Category:Fedora {0} Test Results".format(
+            self.release)
         self.site = wiki
 
     @property
     def testday_pages(self):
+        """All Test Day pages for this release (as a list)."""
         cat = self.site.pages[
             'Category:Fedora {0} Test Days'.format(self.release)]
         return [page for page in cat if isinstance(page, pg.TestDayPage)]
 
     def milestone_pages(self, milestone=None):
+        """If no milestone, will give all release validation pages for
+        this release (as a generator). If a milestone is given, will
+        give validation pages only for that milestone. Note that this
+        works by category; you may get somewhat different results by
+        using page name prefixes.
+        """
         cat = li.ValidationCategory(self.site, self.release, milestone)
         pgs = self.site.walk_category(cat)
         return (p for p in pgs if isinstance(p, pg.ValidationPage))