From 186803d9a97d7efb089acc470b98293b7e472db5 Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Sun, 23 Mar 2014 00:15:01 +0100
Subject: Fix formatting, some typos, and unused code, and add docstrings
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- No idea why subclasses of ConversationTab were working before
    (info_header was overriden with None in __init__)
- Or why the date parsing worked (“Exeception”)
- Some more reformatting with pylint indications
- Document each module in the tabs module
---
 src/bookmark.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'src/bookmark.py')

diff --git a/src/bookmark.py b/src/bookmark.py
index 95d20734..a68cc27a 100644
--- a/src/bookmark.py
+++ b/src/bookmark.py
@@ -1,3 +1,13 @@
+"""
+Bookmarks module
+
+Therein the bookmark class is defined, representing one conference room.
+This object is used to generate elements for both local and remote
+bookmark storage. It can also parse xml Elements.
+
+This module also defines several functions for retrieving and updating
+bookmarks, both local and remote.
+"""
 import os
 import logging
 from sys import version_info
@@ -70,6 +80,7 @@ class Bookmark(object):
             config.set_and_save('password', self.password, section=self.jid)
         return local
 
+    @staticmethod
     def parse_from_element(el, method=None):
         """
         Generate a Bookmark object from a <conference/> element
-- 
cgit v1.2.3