fix comments

src/ansys/rocky/core/client.py

@@ -4,16 +4,25 @@
 import Pyro5.api
 import serpent
 
+from ansys.rocky.core.exceptions import RockyApiError
+
 _ROCKY_API = None
 
 
 def connect_to_rocky(host: str = "localhost", port: int = 50615) -> "RockyClient":
-    """
-    Connect to a Rocky Application instance.
-
-    :param host: The host name where the application is running.
-
-    :param port: The service port to connect.
+    """Connect to a Rocky Application instance.
+
+    Parameters
+    ----------
+    host : str, optional
+        The host name where the application is running, by default "localhost".
+    port : int, optional
+        The service port to connect, by default 50615.
+    
+    Returns
+    -------
+    RockyClient
+        A client object to interact with the Rocky Application.
     """
     uri = f"PYRO:rocky.api@{host}:{port}"
     global _ROCKY_API
@@ -23,6 +32,13 @@ def connect_to_rocky(host: str = "localhost", port: int = 50615) -> "RockyClient
 
 
 class RockyClient:
+    """A client object to interact with the Rocky Application.
+    
+    Parameters
+    ----------
+    rocky_api : Pyro5.api.Proxy
+        The Pyro5 proxy object to interact with the Rocky Application.
+    """
     def __init__(self, rocky_api):
         self._api_adapter = rocky_api
 
@@ -35,6 +51,15 @@ def close(self):
 
 
 class _ApiElementProxy:
+    """A proxy object for API Elements.
+    
+    Parameters
+    ----------
+    pyro_api : Pyro5.api.Proxy
+        The Pyro5 proxy object to interact with the Rocky Application.
+    pool_id : int
+        The ID of the API Element.
+    """
     def __init__(self, pyro_api, pool_id):
         self._pool_id = pool_id
         self._pyro_api = pyro_api
@@ -48,17 +73,40 @@ def CallProxy(*args, **kwargs):
         return CallProxy
 
     @classmethod
-    def deserialize(cls, classname, serialized):
+    def deserialize(cls, serialized: dict) -> "_ApiElementProxy":
+        """Deserialize an API Element Proxy object.
+
+        Parameters
+        ----------
+        serialized : dict
+            The serialized object.
+
+        Returns
+        -------
+        _ApiElementProxy
+            The deserialized object.
+        """
         return cls(_ROCKY_API, serialized["_api_element_id"])
 
     @classmethod
     def serialize(cls, obj) -> dict:
+        """Serialize an API Element Proxy object.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to be serialized.
+
+        Returns
+        -------
+        dict
+            The serialized object.
+        """
         return {"__class__": cls.__name__, "_api_element_id": obj._pool_id}
 
 
 class _ApiListProxy(_ApiElementProxy):
-    """
-    A proxy object for API Elements that implement the sequence interface.
+    """A proxy object for API Elements that implement the sequence interface.
     """
 
     def __len__(self) -> int:
@@ -75,13 +123,37 @@ def __delitem__(self, index: int) -> None:
         self._pyro_api.SendToSubject(self._pool_id, "__delitem__", index)
 
 
-def deserialize_api_error(classname, serialized):
+def deserialize_api_error(serialized):
+    """Deserialize an API Error.
+    
+    Parameters
+    ----------
+    serialized : dict
+        The serialized object.
+
+    Returns
+    -------
+    RockyApiError
+        The error in serialized object.
+    """
     return RockyApiError(serialized["message"])
 
 
-def deserialize_numpy(classname, serialized):
-    bytes = serpent.tobytes(serialized["bytes"])
-    return pickle.loads(bytes)
+def deserialize_numpy(serialized):
+    """Deserialize a numpy array.
+
+    Parameters
+    ----------
+    serialized : dict
+        The serialized object.
+
+    Returns
+    -------
+    Any
+        The deserialized object.
+    """
+    bytes_rocky = serpent.tobytes(serialized["bytes"])
+    return pickle.loads(bytes_rocky)
 
 
 Pyro5.api.register_dict_to_class("ApiElementProxy", _ApiElementProxy.deserialize)
@@ -92,7 +164,4 @@ def deserialize_numpy(classname, serialized):
 Pyro5.api.register_class_to_dict(_ApiElementProxy, _ApiElementProxy.serialize)
 
 
-class RockyApiError(Exception):
-    """
-    Exception class representing an error generated in the API layer.
-    """
+

src/ansys/rocky/core/exceptions.py

@@ -2,4 +2,9 @@ class PyRockyError(Exception):
     """Generic exception for PyRocky API"""
 
 class RockyLaunchError(PyRockyError):
-    """Raised for errors occurred during Rocky application launch"""
+    """Raised for errors occurred during Rocky application launch"""
+
+class RockyApiError(Exception):
+    """
+    Exception class representing an error generated in the API layer.
+    """