FIX: Fix terminal methods (#347)

ansys · Feb 1, 2024 · 4964d8e · 4964d8e
1 parent b63ecde
commit 4964d8e
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 91 deletions.
diff --git a/doc/source/api/glossary.rst b/doc/source/api/glossary.rst
@@ -26,32 +26,44 @@ Glossary
 
 	ValueLike
 
-		:obj:`Union <typing.Union>`\[:obj:`int`, :obj:`float`, :obj:`complex`, :obj:`str`, :class:`Value <ansys.edb.core.utility.Value>`\]
+		Any of the following data types that represents a numeric value
 
-	Point3DLike
+		- :obj:`int`
+		- :obj:`float`
+		- :obj:`complex`
+		- :obj:`str` for expressions ('1nm', 'x + 1' etc)
+		- :class:`Value <ansys.edb.core.utility.Value>`
+
+	Point2DLike
+
+		Any of the following data types that represents (x, y) point on a 2D coordinate system.
 
-		:obj:`tuple`\[:term:`ValueLike`, :term:`ValueLike`, :term:`ValueLike`\]
+		- :class:`PointData <ansys.edb.core.geometry.PointData>`
+		- (:term:`ValueLike`, :term:`ValueLike`) or any other iterable with 2 :term:`ValueLike` inside
+
+	Point3DLike
 
-	PointDataTuple
+		Any of the following data types that represents (x, y, z) point on a 3D coordinate system.
 
-		:obj:`tuple`\[:class:`PointData <ansys.edb.core.geometry.PointData>`, :class:`PointData <ansys.edb.core.geometry.PointData>`\]`
+		- :class:`Point3DData <ansys.edb.core.geometry.Point3DData>`
+		- (:term:`ValueLike`, :term:`ValueLike`, :term:`ValueLike`) or any other iterable with 3 :term:`ValueLike` inside
 
 	Triangle3DLike
 
-		:obj:`tuple`\[:term:`Point3DLike`, :term:`Point3DLike`, :term:`Point3DLike`\]
+		(:term:`Point3DLike`, :term:`Point3DLike`, :term:`Point3DLike`)
 
 	RoughnessModel
 
 		A Groisse roughness model is represented by a single value containing the roughness value.
 		A Huray roughness model is represented  by a tuple of the form [nodule_radius_value, surface_ratio_value]
 
-		:obj:`Union <typing.Union>`\[:term:`ValueLike`, :obj:`tuple`\[:term:`ValueLike`, :term:`ValueLike`\]]
+		:obj:`Union <typing.Union>`\[:term:`ValueLike`, (:term:`ValueLike`, :term:`ValueLike`)]
 
 	HFSSSolverProperties
 
 		HFSS solver properties are represented by a tuple of the form [dc_thickness_type, dc_thickness_value, solve_inside_enabled]
 
-		:obj:`tuple`\[:class:`DCThicknessType <ansys.edb.core.layer.DCThicknessType>`, :term:`ValueLike`, :obj:`bool`\]
+		(:class:`DCThicknessType <ansys.edb.core.layer.DCThicknessType>`, :term:`ValueLike`, :obj:`bool`)
 
 	HFSSExtents
 

diff --git a/src/ansys/edb/core/primitive/primitive.py b/src/ansys/edb/core/primitive/primitive.py
@@ -1968,7 +1968,7 @@ def create(cls, layout, zone_prim, bend_middle, bend_radius, bend_angle):
             Layout to create the board bend definition in.
         zone_prim : :class:`Primitive <Primitive>`
             Zone primitive to create the board bend definition on.
-        bend_middle : :term:`PointDataTuple`
+        bend_middle : (:term:`Point2DLike`, :term:`Point2DLike`)
             Tuple containing the starting and ending points of the line that represents
             the middle of the bend.
         bend_radius : :term:`ValueLike`
@@ -2004,7 +2004,7 @@ def boundary_primitive(self):
     @property
     @parser.to_point_data_pair
     def bend_middle(self):
-        """:term:`PointDataTuple`: Tuple of the bend middle based on the starting and ending points."""
+        """(:term:`Point2DLike`, :term:`Point2DLike`): Tuple of the bend middle based on starting and ending points."""
         return self.__stub.GetBendMiddle(self.msg)
 
     @bend_middle.setter