add issue numbers to TODOs

eitprocessing/binreader/phases.py

@@ -13,7 +13,7 @@ class PhaseIndicator:
     index: int
     time: float
 
-    # TODO: QUESTION: how does this differ the default __eq__ function for a dataclass?
+    # TODO (#78): QUESTION: how does this differ the default __eq__ function for a dataclass?
     def __eq__(self, other:'PhaseIndicator') -> bool:
         if self.index != other.index:
             return False

eitprocessing/binreader/sequence.py

@@ -438,7 +438,7 @@ def _read_frame(
         event_text = reader.string(length=30)
         timing_error = reader.int32()
 
-        # TODO: parse medibus data into waveform data
+        # TODO (#79): parse medibus data into waveform data
         medibus_data = reader.float32(  # noqa; variable will be used in future version
             length=52
         )
@@ -496,7 +496,7 @@ def _load_data(self, first_frame: int):
             )
         self.nframes = data.shape[0]
 
-        # TODO: QUESTION: check whether below issue was only a Drager problem or also
+        # TODO (#80): QUESTION: check whether below issue was only a Drager problem or also
         # applicable to Timpel.
         # The implemented method seems convoluted: it's easier to create an array
         # with nframes and add a time_offset. However, this results in floating

tests/test_sequence.py

@@ -128,7 +128,7 @@ def test_merge(
         draeger_data1.framerate = 50
         _ = Sequence.merge(draeger_data1, draeger_data2)
     with pytest.raises(ValueError):
-        # TODO: update this to AttributeError, once equivalence check for
+        # TODO (#77): update this to AttributeError, once equivalence check for
         # framesets is implemented.
         draeger_data1.vendor = Vendor.TIMPEL
         _ = Sequence.merge(draeger_data1, timpel_data)
@@ -216,7 +216,7 @@ def test_load_partial(
     # marker was tricky to implement, so keeping this cutoff will ensure that
     # code keeps working for this fringe situation.
 
-    # TODO: test what happens if a file has an actual event marker on the very
+    # TODO (#81): test what happens if a file has an actual event marker on the very
     # first frame. I suspect this will not be loaded, but I don't have a test
     # file for this situation.
 
@@ -250,7 +250,7 @@ def test_illegal_first():
 def test_select_by_time(
     draeger_data2: DraegerSequence,
 ):
-    # TODO: this function is kinda ugly. Would be nice to refactor it
+    # TODO (#82): this function is kinda ugly. Would be nice to refactor it
     # but I am struggling to think of a logical way to loop through.
     data = draeger_data2
     t22 = 55825.268