FIX: Readibility improvements (#5544)

ansys · Dec 12, 2024 · 7ba1650 · 7ba1650
1 parent 3735ef4
commit 7ba1650
Show file tree

Hide file tree

Showing 37 changed files with 339 additions and 329 deletions.
diff --git a/src/ansys/aedt/core/application/analysis_3d.py b/src/ansys/aedt/core/application/analysis_3d.py
@@ -183,8 +183,7 @@ def post(self):
 
         Returns
         -------
-        :class:`ansys.aedt.core.visualization.post.post_common_3d.PostProcessor3D` or
-        :class:`ansys.aedt.core.visualization.post.post_icepak.PostProcessorIcepak`
+        :class:`ansys.aedt.core.visualization.post.post_common_3d.PostProcessor3D`
             PostProcessor object.
         """
         if self._post is None and self._odesign:

diff --git a/src/ansys/aedt/core/application/analysis_nexxim.py b/src/ansys/aedt/core/application/analysis_nexxim.py
@@ -217,7 +217,12 @@ def nominal_sweep(self):
 
     @property
     def modeler(self):
-        """Modeler object."""
+        """Modeler object.
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modeler.schematic.ModelerNexxim`
+        """
         if self._modeler is None and self._odesign:
             self.logger.reset_timer()
             from ansys.aedt.core.modeler.schematic import ModelerNexxim
@@ -270,7 +275,7 @@ def sources(self):
 
         Returns
         -------
-        List of :class:`ansys.aedt.core.modules.boundary.Sources`
+        List of :class:`ansys.aedt.core.modules.boundary.circuit_boundary.Sources`
             List of sources.
 
         """

diff --git a/src/ansys/aedt/core/application/design.py b/src/ansys/aedt/core/application/design.py
@@ -348,7 +348,8 @@ def boundaries(self):
 
         Returns
         -------
-        List of :class:`ansys.aedt.core.modules.boundary.BoundaryObject`
+        List[:class:`ansys.aedt.core.modules.boundary.common.BoundaryObject`]
+
         """
         bb = []
         if self.oboundary and "GetBoundaries" in self.oboundary.__dir__():
@@ -465,7 +466,7 @@ def boundaries_by_type(self):
 
         Returns
         -------
-        Dictionary of boundaries.
+        Dict[str, :class:`ansys.aedt.core.modules.boundary.common.BoundaryObject`]
         """
         _dict_out = {}
         for bound in self.boundaries:
@@ -2352,7 +2353,7 @@ def _get_boundaries_data(self):
 
         Returns
         -------
-        [:class:`ansys.aedt.core.modules.boundary.BoundaryObject`]
+        List[:class:`ansys.aedt.core.modules.boundary.common.BoundaryObject`]
         """
         boundaries = []
         if self.design_properties and "BoundarySetup" in self.design_properties:

diff --git a/src/ansys/aedt/core/application/variables.py b/src/ansys/aedt/core/application/variables.py
@@ -468,10 +468,12 @@ def variables(self):
 
         Returns
         -------
-        dict
+
+        dict[str, :class:`ansys.aedt.core.application.variables.Variable`]
             Dictionary of the `Variable` objects for each project variable and each
             design property in the active design.
 
+
         References
         ----------
 

diff --git a/src/ansys/aedt/core/emit.py b/src/ansys/aedt/core/emit.py
@@ -202,8 +202,8 @@ def modeler(self):
 
         Returns
         -------
-        ansys.aedt.core.modeler.schematic.ModelerEmit
-            Design oModeler
+        :class:`ansys.aedt.core.modeler.schematic.ModelerEmit`
+            Design oModeler.
         """
         return self._modeler
 

diff --git a/src/ansys/aedt/core/generic/ibis_reader.py b/src/ansys/aedt/core/generic/ibis_reader.py
@@ -294,7 +294,7 @@ def insert(self, x, y, angle=0.0):
 
         Returns
         -------
-        :class:`ansys.aedt.core.modeler.Object3d.CircuitComponent`
+        :class:`ansys.aedt.core.modeler.circuits.object_3d_circuit.CircuitComponent`
             Circuit Component Object.
 
         """
@@ -455,7 +455,7 @@ def insert(self, x, y, angle=0.0):
 
         Returns
         -------
-        :class:`ansys.aedt.core.modeler.Object3d.CircuitComponent`
+        :class:`ansys.aedt.core.modeler.circuits.object_3d_circuit.CircuitComponent`
             Circuit Component Object.
 
         """
@@ -516,7 +516,7 @@ def insert(self, x, y, angle=0.0):
 
         Returns
         -------
-        :class:`ansys.aedt.core.modeler.Object3d.CircuitComponent`
+        :class:`ansys.aedt.core.modeler.circuits.object_3d_circuit.CircuitComponent`
             Circuit Component Object.
 
         """