changeset 245:8e73a8ae863f

Fix the docstrings
author Dirk Olmes <dirk@xanthippe.ping.de>
date Tue, 09 Jun 2015 02:30:55 +0200
parents b46d7fe6390b
children 7c719c4f5655
files FeedSettings.py backend/AbstractFeedUpdater.py backend/couchdb/CouchDbBackend.py backend/couchdb/FeedEntry.py backend/sqlalchemy/Mapping.py backend/sqlalchemy/SqlAlchemyBackend.py
diffstat 6 files changed, 19 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/FeedSettings.py	Tue Jun 09 02:19:00 2015 +0200
+++ b/FeedSettings.py	Tue Jun 09 02:30:55 2015 +0200
@@ -2,11 +2,11 @@
 from PyQt4.QtGui import QDialog
 from Ui_FeedSettings import Ui_FeedSettings
 
+"""
+Copy all feed properties into the GUI on initialization. Collect all changes
+in a separate dict that's passed into the backend along with the feed to modify.
+"""
 class FeedSettings(QDialog):
-    """
-    Copy all feed properties into the GUI on initialization. Collect all changes
-    in a separate dict that's passed into the backend along with the feed to modify.
-    """
     def __init__(self, backend):
         super(FeedSettings, self).__init__(None)
         self.backend = backend
--- a/backend/AbstractFeedUpdater.py	Tue Jun 09 02:19:00 2015 +0200
+++ b/backend/AbstractFeedUpdater.py	Tue Jun 09 02:30:55 2015 +0200
@@ -8,11 +8,11 @@
 STATUS_ERROR = 400
 log = logging.getLogger("FeedUpdater")
 
+"""
+Abstract base class for FeedUpdater implementations - handles all the parsing of the feed.
+Subclasses need to implement creating and storing the new feed entries.
+"""
 class AbstractFeedUpdater(object):
-    '''
-    Abstract base class for FeedUpdater implementations - handles all the parsing of the feed.
-    Subclasses need to implement creating and storing the new feed entries.
-    '''
 
     def __init__(self, preferences):
         self.preferences = preferences
--- a/backend/couchdb/CouchDbBackend.py	Tue Jun 09 02:19:00 2015 +0200
+++ b/backend/couchdb/CouchDbBackend.py	Tue Jun 09 02:30:55 2015 +0200
@@ -8,10 +8,10 @@
 from backend.couchdb.Feed import Feed
 from backend.couchdb.FeedEntry import FeedEntry
 
+"""
+Backend that uses CouchDB for persistence
+"""
 class CouchDbBackend(AbstractBackend):
-    '''
-    Backend that uses CouchDB for persistence
-    '''
 
     def __init__(self):
         super(CouchDbBackend, self).__init__()
--- a/backend/couchdb/FeedEntry.py	Tue Jun 09 02:19:00 2015 +0200
+++ b/backend/couchdb/FeedEntry.py	Tue Jun 09 02:30:55 2015 +0200
@@ -30,7 +30,7 @@
 
     @staticmethod
     def entriesForFeed(feed, database):
-        ''' the definition of the view makes sure that the entries come out sorted by udpate date '''
+        """ the definition of the view makes sure that the entries come out sorted by udpate date """
         viewResults = FeedEntry.view(database, CouchDb.feedEntriesByFeed(), startkey=[feed.id],
             endkey=[feed.id, {}])
         return list(viewResults)
--- a/backend/sqlalchemy/Mapping.py	Tue Jun 09 02:19:00 2015 +0200
+++ b/backend/sqlalchemy/Mapping.py	Tue Jun 09 02:30:55 2015 +0200
@@ -17,11 +17,11 @@
 mappingDefined = False
 feedEntryTable = None
 
+"""
+Make sure the mapping is defined only once. This is not really needed for the feed updater
+or the GUI app but comes in handy when working interactively with the system.
+"""
 def createMapping(engine):
-    """
-    Make sure the mapping is defined only once. This is not really needed for the feed updater
-    or the GUI app but comes in handy when working interactively with the system. 
-    """
     global mappingDefined
     if not mappingDefined:
         _createMapping(engine)
--- a/backend/sqlalchemy/SqlAlchemyBackend.py	Tue Jun 09 02:19:00 2015 +0200
+++ b/backend/sqlalchemy/SqlAlchemyBackend.py	Tue Jun 09 02:30:55 2015 +0200
@@ -11,11 +11,10 @@
 from sqlalchemy.orm import joinedload
 from sqlalchemy.sql import and_
 
+"""
+Backend that uses sqlalchemy for persistence
+"""
 class SqlAlchemyBackend(AbstractBackend):
-    '''
-    Backend that uses sqlalchemy for persistence
-    '''
-
     def __init__(self):
         AbstractBackend.__init__(self)
         self._initLogging()