updating docstring

alix-tz · Mar 22, 2021 · cb032bc · cb032bc
1 parent e384b2e
commit cb032bc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/aspyre/aspyrelib/aspyre.py b/aspyre/aspyrelib/aspyre.py
@@ -41,6 +41,8 @@ def __init__(self, scenario=None, source=None, destination=None, talkative=False
         :type talkative: bool
         :param test_type: simple initiation for test purpose
         :type test_type: bool
+        :param vpadding: value to add to VPOS attributes in String nodes (PDFALTO scenario)
+        :type vpadding: int
         """
         if test_type == True:
             self.execution_status = "Debug"

diff --git a/aspyre/aspyrelib/manage/manage_pdfaltotoes.py b/aspyre/aspyrelib/manage/manage_pdfaltotoes.py
@@ -218,7 +218,13 @@ def apply_ratio_to_coordinates(xml_tree):
 
 
 def apply_padding(xml_tree, vpadding):
-    """Change values of VPOS attributes in String and TextLine nodes"""
+    """Change values of VPOS attributes in String and TextLine nodes
+
+    :param xml_tree: parsed XML file
+    :type xml_tree: BeautifulSoup
+    :param vpadding: value to add to VPOS attributes
+    :type vpadding: int
+    """
     # un-necessary:
     #for tl in xml_tree.find_all('TextLine'):
     #    if "VPOS" in tl.attrs: