folder/Maildir.py Updated docstrings

This commit is contained in:
Rodolfo García Peñas (kix) 2020-08-30 13:45:05 +02:00
parent 3d2692103f
commit 91df77f69f

View File

@ -282,6 +282,7 @@ class MaildirFolder(BaseFolder):
:param uid: The UID`None`, or a set of maildir flags :param uid: The UID`None`, or a set of maildir flags
:param flags: A set of maildir flags :param flags: A set of maildir flags
:param flags: (optional) Date
:returns: String containing unique message filename""" :returns: String containing unique message filename"""
timeval, timeseq = _gettimeseq(date) timeval, timeseq = _gettimeseq(date)
@ -461,6 +462,7 @@ class MaildirFolder(BaseFolder):
"""Change the message from existing uid to new_uid """Change the message from existing uid to new_uid
This will not update the statusfolder UID, you need to do that yourself. This will not update the statusfolder UID, you need to do that yourself.
:param uid: Message UID
:param new_uid: (optional) If given, the old UID will be changed :param new_uid: (optional) If given, the old UID will be changed
to a new UID. The Maildir backend can implement this as to a new UID. The Maildir backend can implement this as
an efficient rename. an efficient rename.
@ -511,7 +513,6 @@ class MaildirFolder(BaseFolder):
"""Migrate FMD5 hashes from versions prior to 6.3.5 """Migrate FMD5 hashes from versions prior to 6.3.5
:param dryrun: Run in dry run mode :param dryrun: Run in dry run mode
:type fix: Boolean
:return: None :return: None
""" """
oldfmd5 = md5(self.name).hexdigest() oldfmd5 = md5(self.name).hexdigest()