Added test functions comments

Author: pawelad

icon_font_to_png/command_line.py

@@ -3,7 +3,7 @@
 import os
 import argparse
 
-from icon_font_to_png import *
+from icon_font_to_png import IconFont, AVAILABLE_ICON_FONTS
 
 
 def run(arguments):

icon_font_to_png/test/test_command_line.py

@@ -87,7 +87,7 @@ def test_icon_export(capfd):
 
 
 def test_filename_option(capfd):
-    """Test file names"""
+    """Test filename option"""
     css_file = os.path.join('files', 'font-awesome.css')
     ttf_file = os.path.join('files', 'fontawesome-webfont.ttf')
 
@@ -129,7 +129,7 @@ def test_download_option(capfd):
 
 
 # Teardown
-def teardown_module(module):
+def teardown_module():
     """Delete exported icons directory and downloaded FontAwesome files"""
     if os.path.isdir('exported'):
         shutil.rmtree('exported')

icon_font_to_png/test/test_font_awesome.py

@@ -9,10 +9,10 @@
 
 @pytest.fixture(scope='module')
 def font_awesome():
+    """Create a IconFont instance from Font Awesome files"""
     css_file = os.path.join('files', 'font-awesome.css')
     ttf_file = os.path.join('files', 'fontawesome-webfont.ttf')
-    font = icon_font.IconFont(css_file=css_file, ttf_file=ttf_file)
-    return font
+    return icon_font.IconFont(css_file=css_file, ttf_file=ttf_file)
 
 
 def test_font_awesome_load_icons(font_awesome):
@@ -28,7 +28,7 @@ def test_font_awesome_prefix(font_awesome):
 def test_font_awesome_export_icon(font_awesome):
     """Test Font Awesome random icon exporting"""
     icon = random.choice(list(font_awesome.css_icons.keys()))
-    font_awesome.export_icon(icon=icon, size=128, export_dir='/tmp')
-    font_awesome.export_icon(icon=icon, size=128, color='blue', export_dir='/tmp')
-    font_awesome.export_icon(icon=icon, size=256, export_dir='/tmp')
-    font_awesome.export_icon(icon=icon, size=256, color='blue', export_dir='/tmp')
+    font_awesome.export_icon(icon, size=128, export_dir='/tmp')
+    font_awesome.export_icon(icon, size=128, color='blue', export_dir='/tmp')
+    font_awesome.export_icon(icon, size=256, export_dir='/tmp')
+    font_awesome.export_icon(icon, size=256, color='blue', export_dir='/tmp')

icon_font_to_png/test/test_icon_font.py

@@ -13,16 +13,15 @@
 # Module fixtures
 @pytest.fixture(scope='module')
 def font_awesome():
+    """Create a IconFont instance from Font Awesome files"""
     css_file = os.path.join('files', 'font-awesome.css')
     ttf_file = os.path.join('files', 'fontawesome-webfont.ttf')
-    font = icon_font.IconFont(css_file=css_file, ttf_file=ttf_file)
-    return font
+    return icon_font.IconFont(css_file=css_file, ttf_file=ttf_file)
 
 
 # Tests
 def test_init():
     """Test initializing"""
-
     # No arguments
     with pytest.raises(TypeError):
         icon_font.IconFont()
@@ -79,6 +78,7 @@ def test_size(font_awesome, image, size):
     ("rocket_123123.png", '#123123'),
 ])
 def test_color(font_awesome, image, color):
+    """Test color option"""
     original_file = os.path.join('files', image)
 
     font_awesome.export_icon(icon='rocket', size=16, color=color)
@@ -97,6 +97,7 @@ def test_color(font_awesome, image, color):
     ("rocket_auto.png", 'auto'),
 ])
 def test_scale(font_awesome, image, scale):
+    """Test scale option"""
     original_file = os.path.join('files', image)
 
     font_awesome.export_icon(icon='rocket', size=16, scale=scale)
@@ -110,7 +111,7 @@ def test_scale(font_awesome, image, scale):
 
 
 # Teardown
-def teardown_module(module):
+def teardown_module():
     """Delete exported icons directory"""
     if os.path.isdir('exported'):
         shutil.rmtree('exported')

icon_font_to_png/test/test_octicons.py

@@ -9,10 +9,10 @@
 
 @pytest.fixture(scope='module')
 def octicons():
+    """Create a IconFont instance from Octicons files"""
     css_file = os.path.join('files', 'octicons.css')
     ttf_file = os.path.join('files', 'octicons.ttf')
-    font = icon_font.IconFont(css_file=css_file, ttf_file=ttf_file)
-    return font
+    return icon_font.IconFont(css_file=css_file, ttf_file=ttf_file)
 
 
 def test_octicons_load_icons(octicons):