update docstrings and changelog

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## Version 0.2.8
+## Version 0.2.10
+
+- Added a numpy vectorized version of finding gaps (tldr: not fast compared to the traditional version). May be needs a better implementation
+- Added NCLS based intersection operation (based on what pyranges does in their internals)
+- Added tests for intersection operations. 
+
+## Version 0.2.8 - 0.2.9
 
 Optimizing a couple of methods in `IRanges`:
 

src/iranges/IRanges.py

@@ -1044,6 +1044,9 @@ def gaps_numpy(
         """Gaps returns an ``IRanges`` object representing the set of integers that remain after the intervals are
         removed specified by the start and end arguments.
 
+        This function uses a vectorized approach using numpy vectors.
+        The normal :py:meth:`~.gaps` method performs better in most cases.
+
         Args:
             start:
                 Restrict start position. Defaults to 1.
@@ -1705,7 +1708,19 @@ def intersect(self, other: "IRanges") -> "IRanges":
     # Inspired by pyranges intersection using NCLS
     # https://github.com/pyranges/pyranges/blob/master/pyranges/methods/intersection.py
     def intersect_ncls(self, other: "IRanges", delete_index: bool = True) -> "IRanges":
-        # self._build_ncls_index()
+        """Find intersecting intervals with `other`. Uses the NCLS index.
+
+        Args:
+            other:
+                An `IRanges` object.
+
+        Raises:
+            TypeError:
+                If ``other`` is not `IRanges`.
+
+        Returns:
+            A new ``IRanges`` object with all intersecting intervals.
+        """
 
         other._build_ncls_index()