From 5c6e95103e72f1efca5973632cf9fe14e6dc2aa0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodolfo=20Garc=C3=ADa=20Pe=C3=B1as=20=28kix=29?= Date: Sun, 1 Nov 2020 09:21:08 +0100 Subject: [PATCH] Maildir.py added docstrings This patch adds the docstring for the class and for two methods. --- offlineimap/repository/Maildir.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/offlineimap/repository/Maildir.py b/offlineimap/repository/Maildir.py index 39e14b5..53699fc 100644 --- a/offlineimap/repository/Maildir.py +++ b/offlineimap/repository/Maildir.py @@ -25,6 +25,9 @@ from offlineimap.repository.Base import BaseRepository class MaildirRepository(BaseRepository): + """ + Maildir Repository Class + """ def __init__(self, reposname, account): """Initialize a MaildirRepository object. Takes a path name to the directory holding all the Maildir directories.""" @@ -77,6 +80,15 @@ class MaildirRepository(BaseRepository): return self.getconf_xform('localfolders', xforms) def debug(self, msg): + """ + Debug function for the message. It calls the ui.debug function and + prepends the string 'maildir'. + Args: + msg: Message to send to the debug + + Returns: None + + """ self.ui.debug('maildir', msg) def getsep(self): @@ -211,6 +223,12 @@ class MaildirRepository(BaseRepository): return self.folders def getfoldertype(self): + """ + Returns a folder MaildirFolder type. + + Returns: A MaildirFolder class + + """ return folder.Maildir.MaildirFolder def forgetfolders(self):