tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Maildir.py added docstrings

Browse Source 
This patch adds the docstring for the class and for two methods.
This commit is contained in:
Rodolfo García Peñas (kix) 2020-11-01 09:21:08 +01:00
parent e12a702128
commit 5c6e95103e
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
offlineimap/repository/Maildir.py
View File

@ -25,6 +25,9 @@ from offlineimap.repository.Base import BaseRepository
class MaildirRepository(BaseRepository): class MaildirRepository(BaseRepository):
"""
Maildir Repository Class
"""
def __init__(self, reposname, account): def __init__(self, reposname, account):
"""Initialize a MaildirRepository object. Takes a path name """Initialize a MaildirRepository object. Takes a path name
to the directory holding all the Maildir directories.""" to the directory holding all the Maildir directories."""
@ -77,6 +80,15 @@ class MaildirRepository(BaseRepository):
return self.getconf_xform('localfolders', xforms) return self.getconf_xform('localfolders', xforms)
def debug(self, msg): 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) self.ui.debug('maildir', msg)
def getsep(self): def getsep(self):
@ -211,6 +223,12 @@ class MaildirRepository(BaseRepository):
return self.folders return self.folders
def getfoldertype(self): def getfoldertype(self):
"""
Returns a folder MaildirFolder type.
Returns: A MaildirFolder class
"""
return folder.Maildir.MaildirFolder return folder.Maildir.MaildirFolder
def forgetfolders(self): def forgetfolders(self):