Skip to content

Commit 979a8a2

Browse files
DOCS: documentation improvement of create_report method (#6468)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent bf7ef8f commit 979a8a2

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Documentation improvement of create_report method

src/ansys/aedt/core/visualization/post/common.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1350,6 +1350,9 @@ def create_report(
13501350
- For a far fields plot, specify the name of an infinite sphere.
13511351
- For Maxwell 2D/3D Eddy Current solution types this can be provided as a dictionary
13521352
where the key is the matrix name and value the reduced matrix.
1353+
- For Circuit Design, this can provide the plots' time range as a dictionary
1354+
where the keys are ``"time_start"`` and ``"time_stop"``.
1355+
By default ``"time_start"`` is 0ps and the ``"time_stop"`` is 10ns.
13531356
plot_name : str, optional
13541357
Name of the plot. The default is ``None``.
13551358
polyline_points : int, optional,

0 commit comments

Comments
 (0)