Added doc-string to functions

Author: chavarera

examples/with_class_object.py

@@ -10,6 +10,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def run(self):
+        """Code to visit url and fetch cookies and basic info"""
         self.get("https://google.com")
         sessionid = self.session()
         url = self.url()

s_tool/driver.py

@@ -46,6 +46,7 @@ def __exit__(self, type, value, traceback):
         self.close()
 
     def __enter__(self):
+        """llows you to implement objects which can be used easily with the with statement"""
         return self._load_driver()
 
     def _load_driver(self):
@@ -91,6 +92,7 @@ def _load_driver(self):
         return self
 
     def _load_methods(self):
+        """Load basic methods"""
         self.session = partial(get_session, self.driver)
         self.get = partial(visit, self.driver)
         self.text = partial(page_source, self.driver)

s_tool/exceptions.py

@@ -7,4 +7,5 @@ def __init__(self, message):
         self.message = message
 
     def __str__(self):
+        """Returns an Exception"""
         return str(self.message)

s_tool/utils.py

@@ -1,3 +1,6 @@
+"""
+
+"""
 from typing import Union
 
 from selenium import webdriver

tests/test_driver.py

@@ -4,6 +4,7 @@
 
 
 def test_cookies():
+    """Test Basic functionalities for adding and removing cookies."""
     with SeleniumDriver("firefox", headless=True) as obj:
         obj.get("https://www.google.com/")
 
@@ -27,6 +28,7 @@ def test_cookies():
 
 
 def test_base():
+    """Basic operation test cases"""
     with SeleniumDriver("firefox", headless=True) as obj:
         URL = "https://www.google.com/"
         obj.get(URL)

tests/test_elements.py

@@ -4,6 +4,7 @@
 
 
 def test_select_box():
+    """test dropdown selection options"""
     with SeleniumDriver("firefox", headless=True) as obj:
         obj.get(TEST_URL)
 

tests/test_parser.py

@@ -5,6 +5,7 @@
 
 
 def test_select():
+    """Test dropdown related operations"""
     with SeleniumDriver("firefox", headless=True) as obj:
 
         obj.get(TEST_URL)
@@ -39,6 +40,7 @@ def test_select():
 
 
 def test_table():
+    """Test table rows"""
     with SeleniumDriver("firefox", headless=True) as obj:
         obj.get(TEST_URL)
         table = obj.element('//table[@class="table"]', "xpath")

tests/test_version.py

@@ -2,6 +2,7 @@
 
 
 def test_version():
-    # a dummy test, for setting up pytest, tox, and test on ci
-    # will remove it after writing real test cases
+    """A dummy test, for setting up pytest, tox, and test on ci
+    will remove it after writing real test cases
+    """
     assert __version__.startswith("0")