fix: docstyle ordering (#1925)

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

Author: RobPasMue

doc/changelog.d/1925.fixed.md

@@ -0,0 +1 @@
+docstyle ordering

src/ansys/geometry/core/_grpc/_services/_service.py

@@ -35,21 +35,21 @@ class _GRPCServices:
     """
     Placeholder for the gRPC services (i.e. stubs).
 
-    Notes
-    -----
-    This class provides a unified interface to access the different
-    gRPC services available in the Geometry API. It allows for easy
-    switching between different versions of the API by using the
-    `version` parameter in the constructor. The services are lazy-loaded
-    to avoid unnecessary imports and to improve performance.
-
     Parameters
     ----------
     channel : grpc.Channel
         The gRPC channel to the server.
     version : GeometryApiProtos | str | None
         The version of the gRPC API protocol to use. If None, the latest
         version is used.
+
+    Notes
+    -----
+    This class provides a unified interface to access the different
+    gRPC services available in the Geometry API. It allows for easy
+    switching between different versions of the API by using the
+    `version` parameter in the constructor. The services are lazy-loaded
+    to avoid unnecessary imports and to improve performance.
     """
 
     def __init__(self, channel: grpc.Channel, version: GeometryApiProtos | str | None = None):

src/ansys/geometry/core/_grpc/_services/base/conversions.py

@@ -59,11 +59,6 @@ def from_measurement_to_server_angle(input: Measurement) -> float:
 def to_distance(value: float | int) -> Distance:
     """Convert a server value to a Distance object.
 
-    Notes
-    -----
-    The value is converted to a Distance object using the default server length unit.
-    The value should represent a length in the server's unit system.
-
     Parameters
     ----------
     value : float | int
@@ -73,5 +68,10 @@ def to_distance(value: float | int) -> Distance:
     -------
     Distance
         Converted distance.
+
+    Notes
+    -----
+    The value is converted to a Distance object using the default server length unit.
+    The value should represent a length in the server's unit system.
     """
     return Distance(value, DEFAULT_UNITS.SERVER_LENGTH)

src/ansys/geometry/core/_grpc/_version.py

@@ -71,10 +71,6 @@ def from_string(version_string: str) -> "GeometryApiProtos":
     def verify_supported(self, channel: grpc.Channel) -> bool:
         """Check if the version is supported.
 
-        Notes
-        -----
-        This method checks if the server supports the gRPC API protocol version.
-
         Parameters
         ----------
         channel : grpc.Channel
@@ -84,6 +80,10 @@ def verify_supported(self, channel: grpc.Channel) -> bool:
         -------
         bool
             True if the server supports the version, otherwise False.
+
+        Notes
+        -----
+        This method checks if the server supports the gRPC API protocol version.
         """
         pb2_grpc = self.value[1]
         if pb2_grpc is None:

src/ansys/geometry/core/connection/client.py

@@ -51,10 +51,6 @@
 def _create_geometry_channel(target: str) -> grpc.Channel:
     """Create a Geometry service gRPC channel.
 
-    Notes
-    -----
-    Contains specific options for the Geometry service.
-
     Parameters
     ----------
     target : str
@@ -65,6 +61,10 @@ def _create_geometry_channel(target: str) -> grpc.Channel:
     -------
     ~grpc.Channel
         gRPC channel for the Geometry service.
+
+    Notes
+    -----
+    Contains specific options for the Geometry service.
     """
     return grpc.insecure_channel(
         target,
@@ -94,16 +94,16 @@ def wait_until_healthy(channel: grpc.Channel | str, timeout: float) -> grpc.Chan
         * If the total elapsed time exceeds the value for the ``timeout`` parameter,
           a ``TimeoutError`` is raised.
 
-    Raises
-    ------
-    TimeoutError
-        Raised when the total elapsed time exceeds the value for the ``timeout`` parameter.
-
     Returns
     -------
     grpc.Channel
         The channel that was passed in. This channel is guaranteed to be healthy.
         If a string was passed in, a channel is created using the default insecure channel.
+
+    Raises
+    ------
+    TimeoutError
+        Raised when the total elapsed time exceeds the value for the ``timeout`` parameter.
     """
     t_max = time.time() + timeout
     t_out = 0.1

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

@@ -506,12 +506,6 @@ def set_shared_topology(self, share_type: SharedTopologyType) -> None:
     def __build_body_from_response(self, response: dict) -> Body:
         """Build a body from a response dictionary coming out of the gRPC call.
 
-        Notes
-        -----
-        This is a completely private method and is intended to be
-        used only within the class. It handles the MasterBody and
-        Body creation, and addition to the component.
-
         Parameters
         ----------
         response : dict
@@ -521,6 +515,12 @@ def __build_body_from_response(self, response: dict) -> Body:
         -------
         Body
             Body object.
+
+        Notes
+        -----
+        This is a completely private method and is intended to be
+        used only within the class. It handles the MasterBody and
+        Body creation, and addition to the component.
         """
         tb = MasterBody(
             response["master_id"],
@@ -1102,10 +1102,6 @@ def __create_beams_legacy(
     ) -> list[Beam]:
         """Create beams under the component.
 
-        Notes
-        -----
-        This is a legacy method, which is used in versions up to Ansys 25.1.1 products.
-
         Parameters
         ----------
         segments : list[tuple[Point3D, Point3D]]
@@ -1117,6 +1113,10 @@ def __create_beams_legacy(
         -------
         list[Beam]
             A list of the created Beams.
+
+        Notes
+        -----
+        This is a legacy method, which is used in versions up to Ansys 25.1.1 products.
         """
         request = CreateBeamSegmentsRequest(parent=self.id, profile=profile.id)
 

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

@@ -321,11 +321,6 @@ def download(
     def __export_and_download_legacy(self, format: DesignFileFormat) -> bytes:
         """Export and download the design from the server.
 
-        Notes
-        -----
-        This is a legacy method, which is used in versions
-        up to Ansys 25.1.1 products.
-
         Parameters
         ----------
         format : DesignFileFormat
@@ -335,6 +330,11 @@ def __export_and_download_legacy(self, format: DesignFileFormat) -> bytes:
         -------
         bytes
             The raw data from the exported and downloaded file.
+
+        Notes
+        -----
+        This is a legacy method, which is used in versions
+        up to Ansys 25.1.1 products.
         """
         # Process response
         self._grpc_client.log.debug(f"Requesting design download in {format.value[0]} format.")

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

@@ -556,15 +556,15 @@ def tessellate(self, tess_options: TessellationOptions | None = None) -> "pv.Pol
         tess_options : TessellationOptions | None, default: None
             A set of options to determine the tessellation quality.
 
-        Notes
-        -----
-        The tessellation options are ONLY used if the face has not been tessellated before.
-        If the face has been tessellated before, the stored tessellation is returned.
-
         Returns
         -------
         ~pyvista.PolyData
             :class:`pyvista.PolyData` object holding the face.
+
+        Notes
+        -----
+        The tessellation options are ONLY used if the face has not been tessellated before.
+        If the face has been tessellated before, the stored tessellation is returned.
         """
         # If tessellation has not been called before... call it
         if self._body._template._tessellation is None:

src/ansys/geometry/core/parameters/parameter.py

@@ -58,11 +58,6 @@ class ParameterUpdateStatus(Enum):
     def _from_update_status(status: GRPCUpdateStatus) -> "ParameterUpdateStatus":
         """Convert GRPCUpdateStatus to ParameterUpdateStatus.
 
-        Notes
-        -----
-        This method is used to convert the status of the update from gRPC to the
-        parameter update status. Not to be used directly by the user.
-
         Parameters
         ----------
         status : GRPCUpdateStatus
@@ -72,6 +67,11 @@ def _from_update_status(status: GRPCUpdateStatus) -> "ParameterUpdateStatus":
         -------
         ParameterUpdateStatus
             Parameter update status.
+
+        Notes
+        -----
+        This method is used to convert the status of the update from gRPC to the
+        parameter update status. Not to be used directly by the user.
         """
         status_mapping = {
             GRPCUpdateStatus.SUCCESS: ParameterUpdateStatus.SUCCESS,
@@ -107,11 +107,6 @@ def __init__(self, id: int, name: str, dimension_type: ParameterType, dimension_
     def _from_proto(cls, proto: GRPCDrivingDimension) -> "Parameter":
         """Create a ``Parameter`` instance from a ``proto`` object.
 
-        Notes
-        -----
-        This method is used to convert the parameter from gRPC to the parameter
-        object. Not to be used directly by the user.
-
         Parameters
         ----------
         proto : GRPCDrivingDimension
@@ -121,6 +116,11 @@ def _from_proto(cls, proto: GRPCDrivingDimension) -> "Parameter":
         -------
         Parameter
             Parameter object.
+
+        Notes
+        -----
+        This method is used to convert the parameter from gRPC to the parameter
+        object. Not to be used directly by the user.
         """
         return cls(
             id=proto.id,
@@ -162,15 +162,15 @@ def dimension_type(self, value: ParameterType):
     def _to_proto(self):
         """Convert a ``Parameter`` instance to a ``proto`` object.
 
-        Notes
-        -----
-        This method is used to convert the parameter from the parameter object to
-        gRPC. Not to be used directly by the user.
-
         Returns
         -------
         GRPCDrivingDimension
             Parameter object in gRPC.
+
+        Notes
+        -----
+        This method is used to convert the parameter from the parameter object to
+        gRPC. Not to be used directly by the user.
         """
         return GRPCDrivingDimension(
             id=self.id,

src/ansys/geometry/core/shapes/curves/nurbs.py

@@ -218,14 +218,6 @@ def project_point(
 
         This method returns the evaluation at the closest point.
 
-        Notes
-        -----
-        Based on `the NURBS book <https://link.springer.com/book/10.1007/978-3-642-59223-2>`_,
-        the projection of a point to a NURBS curve is the solution to the following optimization
-        problem: minimize the distance between the point and the curve. The distance is defined
-        as the Euclidean distance squared. For more information, please refer to
-        the implementation of the `distance_squared` function.
-
         Parameters
         ----------
         point : Point3D
@@ -239,6 +231,13 @@ def project_point(
         CurveEvaluation
             Evaluation at the closest point on the curve.
 
+        Notes
+        -----
+        Based on `the NURBS book <https://link.springer.com/book/10.1007/978-3-642-59223-2>`_,
+        the projection of a point to a NURBS curve is the solution to the following optimization
+        problem: minimize the distance between the point and the curve. The distance is defined
+        as the Euclidean distance squared. For more information, please refer to
+        the implementation of the `distance_squared` function.
         """
         import numpy as np
         from scipy.optimize import minimize