document tests

tests/fgpyo/sam/test_cigar.py

@@ -52,6 +52,9 @@ def test_bad_index_raises_type_error(index: int) -> None:
     ],
 )
 def test_query_alignment_offsets(cigar_string: str, expected_range: Tuple[int, int]) -> None:
+    """
+    cig.query_alignment_offsets() should return the expected results.
+    """
     cig = Cigar.from_cigarstring(cigar_string)
     ret = cig.query_alignment_offsets()
     assert ret == expected_range
@@ -70,6 +73,7 @@ def test_query_alignment_offsets(cigar_string: str, expected_range: Tuple[int, i
     ],
 )
 def test_query_alignment_offsets_failures(cigar_string: str) -> None:
+    """query_alignment_offsets() should raise a ValueError if the CIGAR has no aligned positions."""
     cig = Cigar.from_cigarstring(cigar_string)
     with pytest.raises(ValueError):
         cig.query_alignment_offsets()
@@ -96,6 +100,10 @@ def test_query_alignment_offsets_failures(cigar_string: str) -> None:
 def test_query_alignment_offsets_reversed(
     cigar_string: str, expected_range: Tuple[int, int]
 ) -> None:
+    """
+    cig.revered().query_alignment_offsets() should return the expected results.
+    """
+
     cig = Cigar.from_cigarstring(cigar_string)
 
     ret = cig.reversed().query_alignment_offsets()