Added doc strings #207

Author: dpuenteramirez

instance_selection/_LocalSets.py

@@ -88,6 +88,19 @@ def _find_enemy_distance(
         label,
         labels,
     ):
+        """
+        It finds the closest enemy sample to the current sample
+
+        :param closest_enemy_distance: the distance to the closest enemy sample
+        :param closest_enemy_sample: the index of the closest enemy sample
+        :param distances: the distance matrix
+        :param index: the index of the current sample
+        :param instances: the data
+        :param label: the label of the current sample
+        :param labels: the labels of the samples
+        :return: The closest enemy distance and the index of the closest enemy
+        sample.
+        """
         for index2, (_, label2) in enumerate(zip(instances, labels)):
             if index == index2 or label == label2:
                 continue

semisupervised/DensityPeaks.py

@@ -260,6 +260,7 @@ def __step_a(self):
         return samples_labeled
 
     def __discover_structure(self):
+        """Discovers the under laying structure."""
         self._fit_without()
 
     def __nan_search(self):

tests/test_InstanceSelection.py

@@ -23,6 +23,7 @@ def to_dataframe(y):
     """
     if not isinstance(y, pd.DataFrame):
         return pd.DataFrame(y)
+    return y
 
 
 @pytest.fixture

utils/dir.py

@@ -8,6 +8,11 @@
 
 
 def check_dir(path):
+    """
+    If the path doesn't exist, create it
+
+    :param path: the path to the folder where the ranks solutions will be saved
+    """
     if not os.path.isdir(path):
         os.mkdir(path)
         if os.path.isdir(path):