Add docstrings, bump version

pictureshow/__init__.py

@@ -1,7 +1,7 @@
 from pictureshow.exceptions import PageSizeError, MarginError, LayoutError
 from pictureshow.core import PictureShow, pictures_to_pdf
 
-__version__ = '0.5.0'
+__version__ = '0.6.0'
 
 __all__ = ['__version__', 'PictureShow', 'pictures_to_pdf',
            'PageSizeError', 'MarginError', 'LayoutError']

pictureshow/cli.py

@@ -50,6 +50,7 @@ def report_results(num_ok, errors, target_path, verbose=False):
 
 
 def _number(number, noun):
+    """Return a repr of amount in correct grammatical number."""
     suffix = 's' if number > 1 else ''
     return f'{number} {noun}{suffix}'
 

tests/unit_test.py

@@ -21,6 +21,7 @@
 
 
 def picture():
+    """Return a mock to replace ImageReader objects in tests."""
     image_reader = create_autospec(ImageReader, instance=True)
     image_reader.getSize.return_value = (640, 400)
     return image_reader