From 1baa456d6e88cf65ac4e161d0daaf08687594312 Mon Sep 17 00:00:00 2001 From: Devin <38879940+Devin-Crawford@users.noreply.github.com> Date: Thu, 2 Jan 2025 11:08:33 +0100 Subject: [PATCH] DOCS: Update ParametricSetups docstring (#5617) --- src/ansys/aedt/core/modules/design_xploration.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/ansys/aedt/core/modules/design_xploration.py b/src/ansys/aedt/core/modules/design_xploration.py index e3387c9a5fe..5ef05363145 100644 --- a/src/ansys/aedt/core/modules/design_xploration.py +++ b/src/ansys/aedt/core/modules/design_xploration.py @@ -1162,10 +1162,13 @@ def add( Variation Start Point if a variation is defined or Single Value. end_point : float or int, optional Variation End Point. This parameter is optional if a Single Value is defined. - step : float or int - Variation Step or Count depending on variation_type. The default is ``100``. + step : float, int, or str + Variation Step or Count depending on variation_type. The default is ``100`` + for the "LinearCount" variation_type. If a string is passed as an argument, it + must be a valid expression in the given context. For example, "0.1mm" may be passed + for a step size when the variation_type is "LinearStep". variation_type : str, optional - Variation Type. Admitted values are `"LinearCount"`, `"LinearStep"`, `"LogScale"`, `"SingleValue"`. + Variation Type. Permitted values are `"LinearCount"`, `"LinearStep"`, `"LogScale"`, `"SingleValue"`. solution : str, optional Type of the solution. The default is ``None``, in which case the default solution is used.