Merge remote-tracking branch 'upstream/master'

conftest.py

@@ -0,0 +1,11 @@
+# Included this file at the root level for future testing scenarios 
+# as per https://stackoverflow.com/a/34520971/307454
+# sample fixture code provided below
+"""
+import pytest
+
+@pytest.fixture
+def input_value():
+   input = 39
+   return input
+"""

first_timers/run.py

@@ -35,6 +35,10 @@ def updateDB(all_issues, db_path):
               is_flag=True,
               help='Run in debug mode (does not tweet).')
 def run(only_save, db_path, create, creds_path, debug):
+    """The function that gets repetitively called via cron.
+    - Updates the DB file with new issues
+    - Sends out corresponding tweets for those new issues
+    """    
     dbExists = os.path.exists(db_path)
     if not dbExists and not create:
         click.secho('DB file does not exist and argument'

tests/test_basic.py

@@ -13,7 +13,6 @@ def test_fetcher():
     """Test whether first_timer_issues are getting picked up."""
     issue_label = ('good first issue')
     new_issues = first_timers.get_first_timer_issues(issue_label)
-
     assert new_issues
 
 
@@ -27,6 +26,10 @@ def test_get_fresh():
 
 
 def test_humanize_url():
+    """Test whether the humanization of api endpoint works.
+    Please see https://en.wikipedia.org/wiki/URI_normalization
+    """
+
     api_url = "https://api.github.com/repos/tidusjar/NZBDash/issues/53"
     human_url = 'https://github.com/tidusjar/NZBDash/issues/53'
     assert first_timers.humanize_url(api_url) == human_url