From 942859601d5d08f05b374d1f12270192cede1155 Mon Sep 17 00:00:00 2001
From: jvoisin
Date: Thu, 19 Jul 2018 23:10:27 +0200
Subject: Improve the code's documentation

---
 libmat2/abstract.py | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'libmat2/abstract.py')

diff --git a/libmat2/abstract.py b/libmat2/abstract.py
index 41a720a..701ab60 100644
--- a/libmat2/abstract.py
+++ b/libmat2/abstract.py
@@ -6,10 +6,16 @@ assert Set  # make pyflakes happy
 
 
 class AbstractParser(abc.ABC):
+    """ This is the base classe of every parser.
+    It might yeild `ValueError` on instanciation on invalid files.
+    """
     meta_list = set()  # type: Set[str]
     mimetypes = set()  # type: Set[str]
 
     def __init__(self, filename: str) -> None:
+        """
+        :raises ValueError: Raised upon an invalid file
+        """
         self.filename = filename
         fname, extension = os.path.splitext(filename)
         self.output_filename = fname + '.cleaned' + extension
@@ -23,5 +29,8 @@ class AbstractParser(abc.ABC):
         pass  # pragma: no cover
 
     def remove_all_lightweight(self) -> bool:
-        """ Remove _SOME_ metadata. """
+        """ This method removes _SOME_ metadata.
+        I might be useful to implement it for fileformats that do
+        not support non-destructive cleaning.
+        """
         return self.remove_all()
-- 
cgit v1.3