[PATCH 09/13] Improve documentation
Sebastian Spaeth
Sebastian at SSpaeth.de
Wed Nov 24 09:56:46 GMT 2010
Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
---
offlineimap/__init__.py | 3 ++-
offlineimap/accounts.py | 8 ++++++++
2 files changed, 10 insertions(+), 1 deletions(-)
diff --git a/offlineimap/__init__.py b/offlineimap/__init__.py
index fd008b0..555a133 100644
--- a/offlineimap/__init__.py
+++ b/offlineimap/__init__.py
@@ -15,7 +15,8 @@ banner = __bigcopyright__ + """
This software comes with ABSOLUTELY NO WARRANTY; see the file
COPYING for details. This is free software, and you are welcome
-to distribute it under the conditions laid out in COPYING."""
+to distribute it under the conditions laid out in COPYING.
+"""
__homepage__ = "http://github.com/spaetz/offlineimap"
__license__ = "Licensed under the GNU GPL v2+ (v2 or any later version)."
diff --git a/offlineimap/accounts.py b/offlineimap/accounts.py
index e64965b..fe5b4dc 100644
--- a/offlineimap/accounts.py
+++ b/offlineimap/accounts.py
@@ -103,6 +103,14 @@ def AccountHashGenerator(customconfig):
mailboxes = []
class Account(CustomConfig.ConfigHelperMixin):
+ """IMAP account base class.
+
+ If you need a syncable account, use class:`SyncableAccount`..
+
+ ConfigHelperMixin requires a class to provide the getconfig() and
+ getsection() functions and allows calls such as
+ getconfint(option[, default])."""
+
def __init__(self, config, name):
self.config = config
self.name = name
--
1.7.1
More information about the OfflineIMAP-project
mailing list