network_pf(): docstring conforms now to numpydoc format [skip travis]

matzech · Jul 4, 2019 · 01311e8 · 01311e8
1 parent 6c1bb17
commit 01311e8
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/pypsa/pf.py b/pypsa/pf.py
@@ -144,9 +144,10 @@ def network_pf(network, snapshots=None, skip_pre=False, x_tol=1e-6, use_seed=Fal
 
     Returns
     -------
-    Dictionary with keys 'n_iter', 'converged', 'error' and dataframe
-    values indicating number of iterations, convergence status, and
-    iteration error for each snapshot (rows) and sub_network (columns)
+    dict
+        Dictionary with keys 'n_iter', 'converged', 'error' and dataframe
+        values indicating number of iterations, convergence status, and
+        iteration error for each snapshot (rows) and sub_network (columns)
     """
 
     return _network_prepare_and_run_pf(network, snapshots, skip_pre, linear=False, x_tol=x_tol, use_seed=use_seed)