FIX: Fix primitive doc (#537)

Author: ansminsisung

doc/source/api/primitive.rst

@@ -22,14 +22,16 @@ Classes
 
 Enums
 -----
+.. currentmodule:: ansys.edb.core
 
 .. autosummary::
    :toctree: _autosummary
 
-   bondwire.BondwireCrossSectionType
-   bondwire.BondwireType
-   padstack_instance.BackDrillType
-   path.PathCornerType
-   path.PathEndCapType
-   primitive.PrimitiveType
-   rectangle.RectangleRepresentationType
+   primitive.bondwire.BondwireCrossSectionType
+   primitive.bondwire.BondwireType
+   primitive.padstack_instance.BackDrillType
+   primitive.path.PathCornerType
+   primitive.path.PathEndCapType
+   primitive.primitive.PrimitiveType
+   primitive.rectangle.RectangleRepresentationType
+   edb_defs.LayoutObjType

src/ansys/edb/core/inner/conn_obj.py

@@ -60,7 +60,7 @@ def cast(self):
 
     @property
     def obj_type(self):
-        """:class:`LayoutObjType <ansys.edb.core.edb_defs.LayoutObjType>`: Layout object type.
+        """:class:`.LayoutObjType`: Layout object type.
 
         This property is read-only.
         """
@@ -128,7 +128,7 @@ def group(self, group):
     def net(self):
         """:class:`.Net`: Net of the :term:`Connectable` object.
 
-        This property can be set with a :class:`.Net` instance, a string, or ``None``.
+        This property can be set with a :class:`.Net` instance, a string, or :obj:`None`.
         """
         from ansys.edb.core.net.net import Net
 

src/ansys/edb/core/inner/layout_obj.py

@@ -16,7 +16,7 @@ class LayoutObj(ObjBase):
 
     @property
     def obj_type(self):
-        """:class:`LayoutObjType <ansys.edb.core.edb_defs.LayoutObjType>`: Layout object type.
+        """:class:`.LayoutObjType`: Layout object type.
 
         This property is read-only.
         """

src/ansys/edb/core/primitive/board_bend_def.py

@@ -1,4 +1,12 @@
 """Primitive classes."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ansys.edb.core.layout.layout import Layout
+    from ansys.edb.core.typing import ValueLike, PointLike
+    from ansys.edb.core.geometry.polygon_data import PolygonData
 
 from ansys.api.edb.v1 import board_bend_def_pb2, board_bend_def_pb2_grpc
 
@@ -14,16 +22,23 @@ class BoardBendDef(Primitive):
     __stub: board_bend_def_pb2_grpc.BoardBendDefServiceStub = StubAccessor(StubType.board_bend_def)
 
     @classmethod
-    def create(cls, layout, zone_prim, bend_middle, bend_radius, bend_angle):
+    def create(
+        cls,
+        layout: Layout,
+        zone_prim: Primitive,
+        bend_middle: PointLike,
+        bend_radius: ValueLike,
+        bend_angle: ValueLike,
+    ) -> BoardBendDef:
         """Create a board bend definition.
 
         Parameters
         ----------
-        layout : :class:`.Layout`
+        layout : .Layout
             Layout to create the board bend definition in.
-        zone_prim : :class:`.Primitive`
+        zone_prim : .Primitive
             Zone primitive to create the board bend definition on.
-        bend_middle : (:term:`Point2DLike`, :term:`Point2DLike`)
+        bend_middle : tuple of (: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`
@@ -49,7 +64,7 @@ def create(cls, layout, zone_prim, bend_middle, bend_radius, bend_angle):
         )
 
     @property
-    def boundary_primitive(self):
+    def boundary_primitive(self) -> Primitive:
         """:class:`.Primitive`: Zone primitive the board bend is placed on.
 
         This property is read-only.
@@ -58,35 +73,35 @@ def boundary_primitive(self):
 
     @property
     @parser.to_point_data_pair
-    def bend_middle(self):
+    def bend_middle(self) -> tuple[PointLike, PointLike]:
         """(:term:`Point2DLike`, :term:`Point2DLike`): Tuple of the bend middle based on starting and ending points."""
         return self.__stub.GetBendMiddle(self.msg)
 
     @bend_middle.setter
-    def bend_middle(self, bend_middle):
+    def bend_middle(self, bend_middle: tuple[PointLike, PointLike]):
         self.__stub.SetBendMiddle(messages.point_pair_property_message(self, bend_middle))
 
     @property
-    def radius(self):
-        """:term:`ValueLike`: Radius of the bend."""
+    def radius(self) -> Value:
+        """:class:`.Value`: Radius of the bend."""
         return Value(self.__stub.GetRadius(self.msg))
 
     @radius.setter
-    def radius(self, val):
+    def radius(self, val: ValueLike):
         self.__stub.SetRadius(messages.value_property_message(self, val))
 
     @property
-    def angle(self):
-        """:term:`ValueLike`: Angle of the bend."""
+    def angle(self) -> Value:
+        """:class:`.Value`: Angle of the bend."""
         return Value(self.__stub.GetAngle(self.msg))
 
     @angle.setter
-    def angle(self, val):
+    def angle(self, val: ValueLike):
         self.__stub.SetAngle(messages.value_property_message(self, val))
 
     @property
     @parser.to_polygon_data_list
-    def bent_regions(self):
+    def bent_regions(self) -> list[PolygonData]:
         """:obj:`list` of :class:`.PolygonData`: Bent region polygons.
 
         This list of a collection of polygon data represents the areas bent by the bend definition.