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/images.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'libmat2/images.py')

diff --git a/libmat2/images.py b/libmat2/images.py
index f9171e5..d47536b 100644
--- a/libmat2/images.py
+++ b/libmat2/images.py
@@ -19,6 +19,9 @@ from . import abstract
 assert Set
 
 class _ImageParser(abstract.AbstractParser):
+    """ Since we use `exiftool` to get metadata from
+    all images fileformat, `get_meta` is implemented in this class,
+    and all the image-handling ones are inheriting from it."""
     meta_whitelist = set()  # type: Set[str]
 
     @staticmethod
@@ -72,7 +75,7 @@ class PNGParser(_ImageParser):
 
 class GdkPixbufAbstractParser(_ImageParser):
     """ GdkPixbuf can handle a lot of surfaces, so we're rending images on it,
-        this has the side-effect of removing metadata completely.
+        this has the side-effect of completely removing metadata.
     """
     _type = ''
 
-- 
cgit v1.3