Added simple type-hinting

Author: lucasimi

src/tdamapper/_common.py

@@ -8,7 +8,7 @@
 import io
 import pstats
 import warnings
-from typing import Any, Callable, Protocol
+from typing import Any, Callable, Iterator, Protocol
 
 import numpy as np
 from numpy.typing import NDArray
@@ -33,6 +33,11 @@ def __setitem__(self, index: int, value: Any) -> None:
         Set an item in the array.
         """
 
+    def __iter__(self) -> Iterator[Any]:
+        """
+        Iterate over the array.
+        """
+
 
 def deprecated(msg: str) -> Callable[..., Any]:
     def deprecated_func(func: Callable[..., Any]) -> Callable[..., Any]:
@@ -119,7 +124,6 @@ def get_params(self, deep: bool = True) -> dict[str, Any]:
         Get all public parameters of the object as a dictionary.
 
         :param deep: A flag for returning also nested parameters.
-        :type deep: bool, optional.
         """
         params = {}
         for k, v in self.__dict__.items():
@@ -166,10 +170,8 @@ def clone(obj: Any) -> Any:
     Clone an estimator, returning a new one, unfitted, having the same public
     parameters.
 
-    :param estimator: An estimator to be cloned.
-    :type estimator: A scikit-learn compatible estimator
+    :param obj: An estimator to be cloned.
     :return: A new estimator with the same parameters.
-    :rtype: A scikit-learn compatible estimator
     """
     params = obj.get_params(deep=True)
     obj_noargs = type(obj)()

src/tdamapper/_run_app.py

@@ -1,7 +1,7 @@
 from tdamapper.app import main
 
 
-def run():
+def run() -> None:
     main()