From d5a896dddeba644776d3d44fff0370c7fac465cf Mon Sep 17 00:00:00 2001 From: jvoisin Date: Fri, 27 Nov 2015 12:18:21 +0100 Subject: Add some missing docstrings --- libmat/mutagenstripper.py | 1 + libmat/parser.py | 1 + test/clitest.py | 1 + 3 files changed, 3 insertions(+) diff --git a/libmat/mutagenstripper.py b/libmat/mutagenstripper.py index 7e4beed..0f9520a 100644 --- a/libmat/mutagenstripper.py +++ b/libmat/mutagenstripper.py @@ -12,6 +12,7 @@ class MutagenStripper(parser.GenericParser): self._create_mfile() def _create_mfile(self): + """ This method must be overrriden to instanciate the `mfile` attribute.""" raise NotImplementedError def is_clean(self): diff --git a/libmat/parser.py b/libmat/parser.py index 23cad6b..8e10ae9 100644 --- a/libmat/parser.py +++ b/libmat/parser.py @@ -54,6 +54,7 @@ class GenericParser(object): return True def _is_clean(self, fieldset): + """ Helper method of the `is_clean` one """ for field in fieldset: remove = self._should_remove(field) if remove is True: diff --git a/test/clitest.py b/test/clitest.py index 8d48624..ec3c19c 100644 --- a/test/clitest.py +++ b/test/clitest.py @@ -115,6 +115,7 @@ class TestFileAttributes(unittest.TestCase): class TestUnsupported(test.MATTest): + """ test MAT's behaviour on unsupported files """ def test_abort_unsupported(self): """ test if the cli aborts on unsupported files """ -- cgit v1.3