From 20e33237184c3a18d83805e3ab0110b9adf2f2fc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rodolfo=20Garc=C3=ADa=20Pe=C3=B1as=20=28kix=29?=
 <kix@kix.es>
Date: Sun, 1 Nov 2020 09:47:17 +0100
Subject: [PATCH] Base.py added docstrings

This patch adds multiple docstrings.
---
 offlineimap/repository/Base.py | 82 +++++++++++++++++++++++++++++++++-
 1 file changed, 81 insertions(+), 1 deletion(-)

diff --git a/offlineimap/repository/Base.py b/offlineimap/repository/Base.py
index fdc3413..99d6e66 100644
--- a/offlineimap/repository/Base.py
+++ b/offlineimap/repository/Base.py
@@ -25,6 +25,9 @@ from offlineimap.error import OfflineImapError
 
 
 class BaseRepository(CustomConfig.ConfigHelperMixin):
+    """
+    Base Class for Repository
+    """
     def __init__(self, reposname, account):
         self.ui = getglobalui()
         self.account = account
@@ -83,15 +86,39 @@ class BaseRepository(CustomConfig.ConfigHelperMixin):
         pass
 
     def holdordropconnections(self):
+        """
+        Hold the drop connections functions.
+
+        Returns: None
+
+        """
         pass
 
     def dropconnections(self):
+        """
+        Drop connections functions.
+
+        Returns: None
+
+        """
         pass
 
     def getaccount(self):
+        """
+        This patch returns the account
+
+        Returns: The account
+
+        """
         return self.account
 
     def getname(self):
+        """
+        Get the repository name
+
+        Returns: String with the repository name
+
+        """
         return self.name
 
     def __str__(self):
@@ -104,9 +131,21 @@ class BaseRepository(CustomConfig.ConfigHelperMixin):
         return self._accountname
 
     def getuiddir(self):
+        """
+        The FolderValidity directory
+
+        Returns: The FolderValidity directory
+
+        """
         return self.uiddir
 
     def getmapdir(self):
+        """
+        Get the map dir (UIDMapping)
+
+        Returns: The UIDMapping directory
+
+        """
         return self.mapdir
 
     # Interface from CustomConfig.ConfigHelperMixin
@@ -124,6 +163,12 @@ class BaseRepository(CustomConfig.ConfigHelperMixin):
         return self._readonly
 
     def getlocaleval(self):
+        """
+        Get the account local eval.
+
+        Returns: LocalEval class for account.
+
+        """
         return self.account.getlocaleval()
 
     def getfolders(self):
@@ -138,9 +183,25 @@ class BaseRepository(CustomConfig.ConfigHelperMixin):
         pass
 
     def getsep(self):
+        """
+        Get the separator.
+
+        This function is not implemented.
+
+        Returns: None
+
+        """
         raise NotImplementedError
 
     def getkeywordmap(self):
+        """
+        Get the keyword map.
+
+        This function is not implemented.
+
+        Returns: None
+
+        """
         raise NotImplementedError
 
     def should_sync_folder(self, fname):
@@ -158,11 +219,30 @@ class BaseRepository(CustomConfig.ConfigHelperMixin):
                                                             True)
 
     def makefolder(self, foldername):
-        """Create a new folder."""
+        """
+        Create a new folder.
+        This function is not implemented
 
+        Args:
+            foldername: Folder to create
+
+        Returns: None
+
+        """
         raise NotImplementedError
 
     def deletefolder(self, foldername):
+        """
+        Remove the selected folder.
+
+        This function is not implemented
+
+        Args:
+            foldername: Folder to delete
+
+        Returns: None
+
+        """
         raise NotImplementedError
 
     def getfolder(self, foldername, decode=True):