Add documentation and rename import variable

skimage/_shared/tests/test_version_requirements.py

@@ -4,30 +4,33 @@
 import numpy as np
 from numpy.testing import assert_raises, assert_equal
 import nose
-from skimage._shared import version_requirements as vr
+from skimage._shared import version_requirements as version_req
 
 
 def test_get_module_version():
-    assert vr.get_module_version('numpy')
-    assert vr.get_module_version('scipy')
-    assert_raises(ImportError, lambda: vr.get_module_version('fakenumpy'))
+    assert version_req.get_module_version('numpy')
+    assert version_req.get_module_version('scipy')
+    assert_raises(ImportError,
+                  lambda: version_req.get_module_version('fakenumpy'))
 
 
 def test_is_installed():
-    assert vr.is_installed('python', '>=2.6')
-    assert not vr.is_installed('numpy', '<1.0')
+    assert version_req.is_installed('python', '>=2.6')
+    assert not version_req.is_installed('numpy', '<1.0')
 
 
 def test_require():
 
-    @vr.require('python', '>2.6')
-    @vr.require('numpy', '>1.5')
+    # A function that only runs on Python >2.6 and numpy > 1.5 (should pass)
+    @version_req.require('python', '>2.6')
+    @version_req.require('numpy', '>1.5')
     def foo():
         return 1
 
     assert_equal(foo(), 1)
 
-    @vr.require('scipy', '<0.1')
+    # function that requires scipy < 0.1 (should fail)
+    @version_req.require('scipy', '<0.1')
     def bar():
         return 0
 
@@ -35,6 +38,5 @@ def test_require():
 
 
 def test_get_module():
-    assert_equal(vr.get_module('numpy'), np)
-    assert_equal(vr.get_module('nose'), nose)
-
+    assert_equal(version_req.get_module('numpy'), np)
+    assert_equal(version_req.get_module('nose'), nose)