Merge pull request #171 from open2c/docstring-patch-1

Update overlap docstring - overlap column
open2c · Nov 24, 2023 · fbca3bc · fbca3bc
2 parents 153ba94 + 2a89dc3
commit fbca3bc
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/bioframe/ops.py b/bioframe/ops.py
@@ -403,6 +403,9 @@ def overlap(
     return_overlap : bool
         If True, return overlapping intervals for the overlapping pairs
         as two additional columns (`overlap_start`, `overlap_end`).
+        When `cols1` is modified, `start` and `end` are replaced accordingly.
+        When `return_overlap` is a string, its value is used for naming the overlap
+        columns: `return_overlap + "_start"`, `return_overlap + "_end"`.
         Default False.
 
     suffixes : (str, str)