Change documentation from epydoc to reStructuredText

Thanks to Freso for all the useful comments! Signed-off-by: JoeLametta <JoeLametta@users.noreply.github.com>
2019-03-22 12:43:27 +00:00
parent 1ae6240e63
commit 69f8f39c49
15 changed files with 211 additions and 214 deletions
--- a/whipper/common/path.py
+++ b/whipper/common/path.py
@@ -28,10 +28,10 @@ class PathFilter(object):

    def __init__(self, slashes=True, quotes=True, fat=True, special=False):
        """
-        @param slashes: whether to convert slashes to dashes
-        @param quotes:  whether to normalize quotes
-        @param fat:     whether to strip characters illegal on FAT filesystems
-        @param special: whether to strip special characters
+        :param slashes: whether to convert slashes to dashes
+        :param quotes:  whether to normalize quotes
+        :param fat:     whether to strip characters illegal on FAT filesystems
+        :param special: whether to strip special characters
        """
        self._slashes = slashes
        self._quotes = quotes