chore: adding issue links to TODOs (#1320)

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

Author: RobPasMue

doc/changelog.d/1320.changed.md

@@ -0,0 +1 @@
+chore: adding issue links to TODOs

pyproject.toml

@@ -130,6 +130,10 @@ select = [
     "I",    # isort, see https://docs.astral.sh/ruff/rules/#isort-i
     "N",    # pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
     "PTH",  # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "TD",   # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+]
+ignore = [
+    "TD002", # Missing author in TODOs comment
 ]
 
 [tool.ruff.lint.per-file-ignores]

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

@@ -38,3 +38,4 @@ def validate(*args, **kwargs):  # pragma: no cover
     """Create a client using the default settings and validate it."""
     print(GrpcClient(*args, **kwargs))
     # TODO: consider adding additional server stat reporting
+    # https://github.com/ansys/pyansys-geometry/issues/1319

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

@@ -1465,6 +1465,7 @@ def __generic_boolean_op(
             # TODO: to be deleted - old versions did not have "tool_bodies" in the request
             # This is a temporary fix to support old versions of the server - should be deleted
             # once the server is no longer supported.
+            # https://github.com/ansys/pyansys-geometry/issues/1319
             if not isinstance(other, Iterable):
                 response = self._template._bodies_stub.Boolean(
                     BooleanRequest(body1=self.id, body2=other.id, method=type_bool_op)

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

@@ -22,7 +22,7 @@
 """Provides for managing components."""
 
 from enum import Enum, unique
-import uuid  # TODO: Is ID even needed? Maybe use from SC?
+import uuid
 
 from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
 from ansys.api.geometry.v0.bodies_pb2 import (

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

@@ -184,6 +184,7 @@ def _activate(self, called_after_design_creation: bool = False) -> None:
         self._grpc_client.log.debug(f"Design {self.name} is activated.")
 
     # TODO: allow for list of materials
+    # https://github.com/ansys/pyansys-geometry/issues/1319
     @protect_grpc
     @check_input_types
     @ensure_design_is_active
@@ -196,6 +197,7 @@ def add_material(self, material: Material) -> None:
             Material to add.
         """
         # TODO: Add design id to the request
+        # https://github.com/ansys/pyansys-geometry/issues/1319
         self._materials_stub.AddToDocument(
             AddToDocumentRequest(
                 material=GRPCMaterial(
@@ -827,8 +829,8 @@ def __repr__(self) -> str:
     def __read_existing_design(self) -> None:
         """Read an existing ``Design`` located on the server."""
         #
-        # TODO: This might go out of sync with the _update_design_inplace method.
-        #       Ensure that the two methods are in sync. Especially regarding cleanup.
+        # This might go out of sync with the _update_design_inplace method.
+        # Ensure that the two methods are in sync. Especially regarding cleanup.
         #
         # TODO: Not all features implemented yet. Status is as follows
         #
@@ -854,6 +856,7 @@ def __read_existing_design(self) -> None:
         # - [X] CoordinateSystems
         # - [ ] SharedTopology
         #
+        # https://github.com/ansys/pyansys-geometry/issues/1319
         import time
 
         start = time.time()
@@ -920,10 +923,13 @@ def __read_existing_design(self) -> None:
                 # TODO: Add support for more material properties...
                 #      - Need to add support for more MaterialPropertyTypes
                 #      - Need to add support for more Quantity units
+                # https://github.com/ansys/pyansys-geometry/issues/1319
                 try:
                     mp_type = MaterialPropertyType.from_id(property.id)
-                except ValueError as err:  # TODO: Errors coming from MaterialPropertyType.from_id
+                except ValueError as err:
+                    # TODO: Errors coming from MaterialPropertyType.from_id
                     # because of unsupported MaterialPropertyType entries...
+                    # https://github.com/ansys/pyansys-geometry/issues/1319
                     self._grpc_client.log.warning(
                         f"Material property {property.display_name} of type {property.id} is not supported."  # noqa : E501
                         " Storing as string."
@@ -937,6 +943,7 @@ def __read_existing_design(self) -> None:
                     UndefinedUnitError,
                     TypeError,
                 ) as err:  # TODO: Errors coming from Quantity ctor because of unsupported units...
+                    # https://github.com/ansys/pyansys-geometry/issues/1319
                     self._grpc_client.log.warning(
                         f"Material property {property.display_name} with units {property.units} is not fully supported."  # noqa : E501
                         " Storing value only as float."
@@ -971,8 +978,9 @@ def __read_existing_design(self) -> None:
 
         # Set SharedTopology
         # TODO: Maybe just add it to Component or Part message
-        #          - we're starting to iterate through all the Components too much
-        # TODO: Make sure design doesn't need edge case attention
+        # we're starting to iterate through all the Components too much.
+        # Make sure design doesn't need edge case attention
+        # https://github.com/ansys/pyansys-geometry/issues/1319
         num_created_shared_topologies = 0
         for component_id, shared_topology_type in response.component_shared_topologies.items():
             component = created_components.get(component_id)
@@ -1001,8 +1009,9 @@ def _update_design_inplace(self) -> None:
         # Clear all the existing information
         #
         # TODO: This might go out of sync with the __read_existing_design method
-        #       if the latter is updated and this method is not. Ensure that
-        #       the two methods are in sync.
+        # if the latter is updated and this method is not. Ensure that
+        # the two methods are in sync.
+        # https://github.com/ansys/pyansys-geometry/issues/1319
         #
         self._components = []
         self._bodies = []

src/ansys/geometry/core/logger.py

@@ -374,7 +374,7 @@ def __init__(self, level=logging.DEBUG, to_file=False, to_stdout=True, filename=
         self.logger.addFilter(InstanceFilter())
         self.logger.setLevel(level)
         self.logger.propagate = True
-        self.level = self.logger.level  # TODO: TO REMOVE
+        self.level = self.logger.level
 
         # Writing logging methods.
         self.debug = self.logger.debug

src/ansys/geometry/core/misc/measurements.py

@@ -163,6 +163,7 @@ def __init__(self, value: Union[Real, Quantity], unit: Unit, dimensions: Unit):
         # Check the input
         if isinstance(value, Quantity):
             # TODO: inform that if Quantity is given, we will ignore provided unit value
+            # https://github.com/ansys/pyansys-geometry/issues/1319
             unit = value.units
         else:
             check_is_float_int(value, "value")

src/ansys/geometry/core/modeler.py

@@ -119,6 +119,7 @@ def __init__(
 
         # Initialize the RepairTools - Not available on Linux
         # TODO: delete "if" when Linux service is able to use repair tools
+        # https://github.com/ansys/pyansys-geometry/issues/1319
         if self.client.backend_type == BackendType.LINUX_SERVICE:
             self._repair_tools = None
             self._prepare_tools = None

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

@@ -94,5 +94,5 @@ def trim(self, interval: Interval) -> "TrimmedCurve":
             self.evaluate(interval.start).position,
             self.evaluate(interval.end).position,
             interval,
-            None,  # TODO: calculate length on client?
+            None,
         )