docs: add warning section for minimum version on methods (#2062)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: RobPasMue

doc/changelog.d/2062.documentation.md

@@ -0,0 +1 @@
+Add warning section for minimum version on methods

src/ansys/geometry/core/designer/body.py

@@ -148,7 +148,12 @@ def name(self) -> str:
 
     @abstractmethod
     def set_name(self, str) -> None:
-        """Set the name of the body."""
+        """Set the name of the body.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R1.
+        """
         return
 
     @abstractmethod
@@ -158,17 +163,32 @@ def fill_style(self) -> FillStyle:
 
     @abstractmethod
     def set_fill_style(self, fill_style: FillStyle) -> None:
-        """Set the fill style of the body."""
+        """Set the fill style of the body.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R1.
+        """
         return
 
     @abstractmethod
     def is_suppressed(self) -> bool:
-        """Get the body suppression state."""
+        """Get the body suppression state.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
+        """
         return
 
     @abstractmethod
     def set_suppressed(self, suppressed: bool) -> None:
-        """Set the body suppression state."""
+        """Set the body suppression state.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
+        """
         return
 
     @abstractmethod
@@ -182,14 +202,20 @@ def opacity(self) -> float:
         return
 
     @abstractmethod
-    def set_color(self, color: str | tuple[float, float, float]) -> None:
+    def set_color(
+        self, color: str | tuple[float, float, float] | tuple[float, float, float, float]
+    ) -> None:
         """Set the color of the body.
 
         Parameters
         ----------
-        color : str | tuple[float, float, float]
+        color : str | tuple[float, float, float] | tuple[float, float, float, float]
             Color to set the body to. This can be a string representing a color name
             or a tuple of RGB values in the range [0, 1] (RGBA) or [0, 255] (pure RGB).
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R1.
         """
         return
 
@@ -272,6 +298,10 @@ def bounding_box(self) -> BoundingBox:
         -------
         BoundingBox
             Bounding box of the body.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
         """
         return
 
@@ -430,10 +460,6 @@ def translate(self, direction: UnitVector3D, distance: Quantity | Distance | Rea
             Direction of the translation.
         distance: ~pint.Quantity | Distance | Real
             Distance (magnitude) of the translation.
-
-        Returns
-        -------
-        None
         """
         return
 
@@ -455,57 +481,63 @@ def rotate(
         angle: ~pint.Quantity | Angle | Real
             Angle (magnitude) of the rotation.
 
-        Returns
-        -------
-        None
+        Warnings
+        --------
+        This method is only available starting on Ansys release 24R2.
         """
         return
 
     @abstractmethod
     def scale(self, value: Real) -> None:
         """Scale the geometry body by the given value.
 
+        The calling object is directly modified when this method is called.
+        Thus, it is important to make copies if needed.
+
         Parameters
         ----------
         value: Real
             Value to scale the body by.
 
-        Notes
-        -----
-        The calling object is directly modified when this method is called.
-        Thus, it is important to make copies if needed.
+        Warnings
+        --------
+        This method is only available starting on Ansys release 24R2.
         """
         return
 
     @abstractmethod
     def map(self, frame: Frame) -> None:
         """Map the geometry body to the new specified frame.
 
+        The calling object is directly modified when this method is called.
+        Thus, it is important to make copies if needed.
+
         Parameters
         ----------
         frame: Frame
             Structure defining the orientation of the body.
 
-        Notes
-        -----
-        The calling object is directly modified when this method is called.
-        Thus, it is important to make copies if needed.
+        Warnings
+        --------
+        This method is only available starting on Ansys release 24R2.
         """
         return
 
     @abstractmethod
     def mirror(self, plane: Plane) -> None:
         """Mirror the geometry body across the specified plane.
 
+        The calling object is directly modified when this method is called.
+        Thus, it is important to make copies if needed.
+
         Parameters
         ----------
         plane: Plane
             Represents the mirror.
 
-        Notes
-        -----
-        The calling object is directly modified when this method is called.
-        Thus, it is important to make copies if needed.
+        Warnings
+        --------
+        This method is only available starting on Ansys release 24R2.
         """
         return
 
@@ -522,6 +554,10 @@ def get_collision(self, body: "Body") -> CollisionType:
         -------
         CollisionType
             Enum that defines the collision state between bodies.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 24R2.
         """
         return
 
@@ -615,6 +651,10 @@ def shell_body(self, offset: Real) -> bool:
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
         """
         return
 
@@ -633,6 +673,10 @@ def remove_faces(self, selection: Face | Iterable[Face], offset: Real) -> bool:
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
         """
         return
 
@@ -1097,16 +1141,14 @@ def set_fill_style(  # noqa: D102
     def set_suppressed(  # noqa: D102
         self, suppressed: bool
     ) -> None:
-        """Set the body suppression state."""
         self._grpc_client.log.debug(f"Setting body {self.id}, as suppressed: {suppressed}.")
         self._grpc_client.services.bodies.set_suppressed(bodies=[self.id], is_suppressed=suppressed)
 
     @check_input_types
     @min_backend_version(25, 1, 0)
-    def set_color(
+    def set_color(  # noqa: D102
         self, color: str | tuple[float, float, float] | tuple[float, float, float, float]
     ) -> None:
-        """Set the color of the body."""
         self._grpc_client.log.debug(f"Setting body color of {self.id} to {color}.")
         color = convert_color_to_hex(color)
         self._grpc_client.services.bodies.set_color(id=self.id, color=color)
@@ -1115,7 +1157,12 @@ def set_color(
     @check_input_types
     @min_backend_version(25, 2, 0)
     def set_opacity(self, opacity: float) -> None:
-        """Set the opacity of the body."""
+        """Set the opacity of the body.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
+        """
         self._grpc_client.log.debug(f"Setting body opacity of {self.id} to {opacity}.")
         opacity = convert_opacity_to_hex(opacity)
         new_color = self.color[0:7] + opacity
@@ -1686,7 +1733,9 @@ def set_suppressed(self, suppressed: bool) -> None:  # noqa: D102
         return self._template.set_suppressed(suppressed)
 
     @ensure_design_is_active
-    def set_color(self, color: str | tuple[float, float, float]) -> None:  # noqa: D102
+    def set_color(  # noqa: D102
+        self, color: str | tuple[float, float, float] | tuple[float, float, float, float]
+    ) -> None:
         return self._template.set_color(color)
 
     @ensure_design_is_active