test: add doc

fulcrumgenomics · Jul 15, 2024 · 4ebdba4 · 4ebdba4
1 parent 73be62b
commit 4ebdba4
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/pybedlite/tests/test_overlap_detector.py b/pybedlite/tests/test_overlap_detector.py
@@ -195,8 +195,10 @@ def test_construction_from_interval(bed_records: List[BedRecord]) -> None:
 def test_construction_from_ucsc() -> None:
     """
     `Interval.from_ucsc()` should convert a UCSC position-formatted string to an `Interval`.
-    """
 
+    The position-formatted string should be one-based fully-closed, and the `Interval` should be
+    zero-based half-open.
+    """
     assert Interval.from_ucsc("chr1:101-200") == Interval("chr1", 100, 200)
 
 
@@ -216,5 +218,4 @@ def test_construction_from_ucsc_other_contigs(contig: str) -> None:
     """
     `Interval.from_ucsc()` should accomodate non-human, decoy, custom, and other contig names.
     """
-
     assert Interval.from_ucsc(f"{contig}:101-200") == Interval(contig, 100, 200)