Add docstring for q_sign

openego · Jul 13, 2018 · 6c86c02 · 6c86c02
1 parent 504963d
commit 6c86c02
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/ding0/tools/pypsa_io.py b/ding0/tools/pypsa_io.py
@@ -58,6 +58,22 @@ def export_to_dir(network, export_dir):
 
 
 def q_sign(power_factor_mode_string, sign_convention):
+    """
+    Gets the correct sign for Q time series given 'inductive' and 'capacitive' and the 'generator'
+    or 'load' convention.
+
+    Parameters
+    ----------
+    power_factor_mode_string: :obj:`str`
+        Either 'inductive' or 'capacitive'
+    sign_convention: :obj:`str`
+        Either 'load' or 'generator'
+    Return
+    ------
+    :obj: `int` : +1 or -1
+        A sign to mulitply to Q time sereis
+    """
+
     comparestr = power_factor_mode_string.lower()
 
     if re.fullmatch('inductive', comparestr):