From 2a89dc379826ecb5beb4cc9d34a3177a2c0c042a Mon Sep 17 00:00:00 2001 From: Sergey Venev Date: Wed, 11 Oct 2023 09:59:11 -0400 Subject: [PATCH] Update overlap docstring - overlap column name of the overlap column depends on `return_overlap` and `cols1` which isn't reflected in the docstring --- bioframe/ops.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bioframe/ops.py b/bioframe/ops.py index 02b69d71..bd2e1c60 100644 --- 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)