DOCS: Fix numpy docstyle. (#5606)

src/ansys/aedt/core/application/analysis.py

@@ -1542,7 +1542,6 @@ def get_setup(self, name):
     def create_output_variable(self, variable, expression, solution=None, context=None):
         """Create or modify an output variable.
 
-
         Parameters
         ----------
         variable : str, optional

src/ansys/aedt/core/application/analysis_3d.py

@@ -1472,12 +1472,14 @@ def import_gds_3d(self, input_file: str, mapping_layers: dict, units: str = "um"
     def _find_indices(self, list_to_check, item_to_find):
         # type: (list, str|int) -> list
         """Given a list, returns the list of indices for all occurrences of a given element.
+
         Parameters
         ----------
         list_to_check: list
             List to check.
         item_to_find: str, int
             Element to search for in the list.
+
         Returns
         -------
         list

src/ansys/aedt/core/application/analysis_maxwell_circuit.py

@@ -28,6 +28,7 @@
 
 class AnalysisMaxwellCircuit(Analysis):
     """Provides the Maxwell Circuit (MaxwellCircuit) interface.
+
     Maxwell Circuit Editor has no setup, solution, analysis or postprocessor
     It is automatically initialized by Application call (Maxwell Circuit).
     Refer to Application function for inputs definition

src/ansys/aedt/core/application/analysis_twin_builder.py

@@ -31,14 +31,12 @@
 
 class AnalysisTwinBuilder(Analysis):
     """Provides the Twin Builder Analysis Setup (TwinBuilder).
+
     It is automatically initialized by Application call (Twin Builder).
     Refer to Application function for inputs definition
 
     Parameters
     ----------
-    Returns
-    -------
-
     """
 
     @property

src/ansys/aedt/core/application/design.py

@@ -386,7 +386,6 @@ def design_datasets(self) -> Dict[str, DataSet]:
     def boundaries(self) -> List[BoundaryObject]:
         """Design boundaries and excitations.
 
-
         Returns
         -------
         list[:class:`ansys.aedt.core.modules.boundary.common.BoundaryObject`]
@@ -1026,7 +1025,6 @@ def temp_directory(self) -> str:
     def toolkit_directory(self) -> str:
         """Path to the toolkit directory.
 
-
         Returns
         -------
         str

src/ansys/aedt/core/application/design_solutions.py

@@ -884,6 +884,7 @@ def __init__(self, odesign, design_type, aedt_version):
     @property
     def problem_type(self):
         """Get/Set the problem type of the icepak Design.
+
         It can be any of`"TemperatureAndFlow"`, `"TemperatureOnly"`,`"FlowOnly"`.
         """
         if self._odesign:

src/ansys/aedt/core/desktop.py

@@ -22,8 +22,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""
-This module contains the ``Desktop`` class.
+"""This module contains the ``Desktop`` class.
+
 This module is used to initialize AEDT and the message manager for managing AEDT.
 You can initialize this module before launching an app or
 have the app automatically initialize it to the latest installed AEDT version.
@@ -378,8 +378,10 @@ def is_student_version(oDesktop):
 
 
 def _init_desktop_from_design(*args, **kwargs):
-    """Distinguishes if the ``Desktop`` class is initialized internally from the ``Design``
-    class or directly from the user. For example, ``desktop=Desktop()``)."""
+    """Distinguishes if the ``Desktop`` class is initialized internally.
+
+    It can be initialized from the ``Design`` class or directly from the user.
+    For example, ``desktop=Desktop()``)."""
     Desktop._invoked_from_design = True
     return Desktop(*args, **kwargs)
 

src/ansys/aedt/core/downloads.py

@@ -226,6 +226,7 @@ def download_edb_merge_utility(force_download=False, destination=None):
 
 def download_netlist(destination=None):
     """Download an example of netlist File and return the def path.
+
     Examples files are downloaded to a persistent cache to avoid
     re-downloading the same file twice.
 

src/ansys/aedt/core/emit_core/couplings.py

@@ -22,8 +22,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""
-This module contains these classes: `CouplingsEmit`.
+"""This module contains these classes: `CouplingsEmit`.
+
 This module provides for interacting with EMIT Analysis and Results windows.
 """
 

src/ansys/aedt/core/emit_core/emit_constants.py

@@ -22,8 +22,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""
-Enums from the ``EmitApiPython`` module are defined as ``None`` until this module initializes.
+"""Enums from the ``EmitApiPython`` module are defined as ``None`` until this module initializes.
+
 This allows IDE auto-complete to find them and ``emit_constants`` to import before the
 ``EmitApiPython`` module has loaded (typically when a ``ansys.aedt.core.Emit()`` object is created).
 

src/ansys/aedt/core/emit_core/results/revision.py

@@ -429,8 +429,7 @@ def n_to_1_limit(self, max_instances):
 
     @pyaedt_function_handler()
     def interference_type_classification(self, domain, use_filter=False, filter_list=None):  # pragma: no cover
-        """
-        Classify interference type as according to inband/inband,
+        """Classify interference type as according to inband/inband,
         out of band/in band, inband/out of band, and out of band/out of band.
 
         Parameters

src/ansys/aedt/core/filtersolutions_core/attributes.py

@@ -636,6 +636,7 @@ def filter_type(self, filter_type: FilterType):
     @property
     def filter_class(self) -> FilterClass:
         """Class (band definition) of the filter. The default is ``LOW_PASS``.
+
         The ``FilterClass`` enum provides a list of all classes.
 
         Returns
@@ -654,6 +655,7 @@ def filter_class(self, filter_class: FilterClass):
     @property
     def filter_implementation(self) -> FilterImplementation:
         """Technology for implementing the filter. The default is ``LUMPED``.
+
         The ``FilterImplementation`` enum provides a list of all implementations.
 
         Returns
@@ -770,6 +772,7 @@ def filter_order(self, filter_order: int):
     @property
     def minimum_order_stop_band_attenuation_db(self) -> str:
         """Filter stop band attenuation in dB for calculation of the filter minimum order.
+
         The default is ``50``.
 
         Returns
@@ -791,6 +794,7 @@ def minimum_order_stop_band_attenuation_db(self, minimum_order_stop_band_attenua
     @property
     def minimum_order_stop_band_frequency(self) -> str:
         """Filter stop band frequency for calculation of the filter minimum order.
+
         The default is ``10 GHz``.
 
         Returns
@@ -812,6 +816,7 @@ def minimum_order_stop_band_frequency(self, minimum_order_stop_band_frequency_st
     @property
     def minimum_order_group_delay_error_percent(self) -> str:
         """Filter maximum group delay in % for calculation of the filter minimum order.
+
         The default is ``5``.
 
         Returns
@@ -868,6 +873,7 @@ def ideal_minimum_order(self) -> int:
     @property
     def delay_time(self) -> str:
         """Filter delay time.
+
         The default is ``1 ns``.
 
         Returns
@@ -884,6 +890,7 @@ def delay_time(self, delay_time_string):
     @property
     def pass_band_definition(self) -> PassbandDefinition:
         """Pass band frequency entry options.
+
         The default is ``CENTER_FREQUENCY``.
 
         Returns
@@ -938,6 +945,7 @@ def pass_band_width_frequency(self, pass_band_freq_string):
     @property
     def lower_frequency(self) -> str:
         """Filter lower corner frequency.
+
         The default is ``905 MHz``.
 
         Returns
@@ -954,6 +962,7 @@ def lower_frequency(self, lower_freq_string):
     @property
     def upper_frequency(self) -> str:
         """Filter upper corner frequency.
+
         The default is ``1.105 MHz``.
 
         Returns
@@ -987,6 +996,7 @@ def diplexer_inner_band_width(self, diplexer_inner_band_width_string):
     @property
     def diplexer_outer_band_width(self) -> str:
         """Diplexer outer band width for ``BP1`` and ``Triplexer1`` diplexer types.
+
         The default is ``2 GHz``.
 
         Returns
@@ -1003,6 +1013,7 @@ def diplexer_outer_band_width(self, diplexer_outer_band_width_string):
     @property
     def diplexer_lower_center_frequency(self) -> str:
         """Diplexer lower center frequency for ``BP2`` and ``Triplexer2`` diplexer types.
+
         The default is ``500 MHz``.
 
         Returns
@@ -1078,6 +1089,7 @@ def diplexer_upper_band_width(self, diplexer_upper_band_width_string):
     @property
     def stop_band_definition(self) -> StopbandDefinition:
         """Stop band parameter entry option.
+
         The default is ``RATIO``.
 
         Returns
@@ -1099,6 +1111,7 @@ def stop_band_definition(self, column: StopbandDefinition):
     @property
     def stop_band_ratio(self) -> str:
         """Filter stop band ratio.
+
         The default is ``1.2``.
 
         Returns
@@ -1115,6 +1128,7 @@ def stop_band_ratio(self, stop_band_ratio_string):
     @property
     def stop_band_frequency(self) -> str:
         """Filter stop band frequency.
+
         The default is ``1.2 GHz``.
 
         Returns
@@ -1202,6 +1216,7 @@ def data_transmission_filter(self, data_transmission_filter: bool):
     @property
     def raised_cosine_alpha_percentage(self) -> RaisedCosineAlphaPercentage:
         """Raised cosine alpha percentage.
+
         The default is ''FORTY''.
 
         Returns
@@ -1241,6 +1256,7 @@ def equiripple_delay(self, equiripple_delay: bool):
     @property
     def group_delay_ripple_period(self) -> str:
         """Filter approximate normalized group delay ripple period.
+
         The default is ''2''.
 
         Returns
@@ -1260,6 +1276,7 @@ def group_delay_ripple_period(self, group_delay_ripple_period_string):
     @property
     def normalized_group_delay_percentage(self) -> int:
         """Normalized group delay percentage.
+
         The default is ''0''.
 
         Returns
@@ -1321,6 +1338,7 @@ def bessel_normalized_delay(self, bessel_normalized_delay: bool):
     @property
     def bessel_normalized_delay_period(self) -> str:
         """Bessel filter normalized delay period.
+
         The default is ''2''.
 
         Returns
@@ -1340,6 +1358,7 @@ def bessel_normalized_delay_period(self, bessel_normalized_delay_period_string):
     @property
     def bessel_normalized_delay_percentage(self) -> int:
         """Bessel filter ripple percentage.
+
         The default is ''0''.
 
         Returns
@@ -1361,6 +1380,7 @@ def bessel_normalized_delay_percentage(self, column: BesselRipplePercentage):
     @property
     def pass_band_ripple(self) -> str:
         """Filter pass band ripple in dB.
+
         The default is ''0.05 dB''.
 
         Returns
@@ -1473,6 +1493,7 @@ def asymmetric_low_stop_band_ratio(self, asymmetric_low_stop_band_ratio_string):
     @property
     def asymmetric_high_stop_band_ratio(self) -> str:
         """Stop-band ratio for high side of an asymmetric filter.
+
         The default is ''1.2''.
 
         Returns
@@ -1494,6 +1515,7 @@ def asymmetric_high_stop_band_ratio(self, asymmetric_high_stop_band_ratio_string
     @property
     def asymmetric_low_stop_band_attenuation_db(self) -> str:
         """Stop-band attenuation for low side of an asymmetric filter.
+
         The default is ''60 dB''.
 
         Returns
@@ -1537,6 +1559,7 @@ def asymmetric_high_stop_band_attenuation_db(self, asymmetric_high_stop_band_att
     @property
     def gaussian_transition(self) -> GaussianTransition:
         """Gaussian filter transition option.
+
         The default is ''TRANSITION_NONE''.
 
         Returns
@@ -1683,6 +1706,7 @@ def half_band_ripple(self, half_band_ripple: bool):
     @property
     def constrict_ripple_percent(self) -> str:
         """Filter ripple constriction percentage.
+
         The default is ''50%''.
 
         Returns
@@ -1717,6 +1741,7 @@ def ripple_constriction_band(self, ripple_constriction_band: RippleConstrictionB
     @property
     def single_point_ripple_inf_zeros(self) -> SinglePointRippleInfZeros:
         """Filter number of single point ripple infinite zeros.
+
         The default is ''RIPPLE_INF_ZEROS_1''.
 
         Returns