Skip to content

Commit 51c5d64

Browse files
committed
update the docstring of results
1 parent d30984e commit 51c5d64

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

pygridsim/core.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,9 @@ def results(self, queries: list[str], export_path=""):
179179
180180
Args:
181181
queries (list[str]):
182-
A list of queries to the circuit ("Voltages", "Losses", "TotalPower")
182+
A list of queries to the circuit: one of ("Voltages", "Losses", "TotalPower")
183+
or partial queries ("RealLoss", "ReactiveLoss", "RealPower", "ReactivePower")
184+
that query one component of Losses/TotalPower
183185
export_path (str, optional):
184186
The file path to export results. If empty, results are not exported.
185187
Defaults to "".

0 commit comments

Comments
 (0)