[project] Update TODO style to be clickable

Author: Breakthrough

scenedetect/_cli/commands.py

@@ -504,7 +504,7 @@ def save_otio(
     frame_rate = context.video_stream.frame_rate
 
     # List of track mapping to resource type.
-    # TODO(#497): Allow exporting without an audio track.
+    # TODO(https://scenedetect.com/issues/497): Allow OTIO export without an audio track.
     track_list = {"Video 1": "Video"}
     if audio:
         track_list["Audio 1"] = "Audio"

scenedetect/_cli/controller.py

@@ -120,7 +120,7 @@ def _detect(context: CliContext) -> ty.Optional[ty.Tuple[SceneList, CutList]]:
     )
 
     # Handle case where video failure is most likely due to multiple audio tracks (#179).
-    # TODO(#380): Ensure this does not erroneusly fire.
+    # TODO(https://scenedetect.com/issues/380): Ensure this does not erroneusly fire.
     if num_frames <= 0 and isinstance(context.video_stream, VideoStreamCv2):
         logger.critical(
             "Failed to read any frames from video file. This could be caused by the video"

scenedetect/backends/moviepy.py

@@ -185,10 +185,11 @@ def seek(self, target: ty.Union[FrameTimecode, float, int]):
             )
             success = True
         except OSError as ex:
-            # TODO(#380): Other backends do not currently throw an exception if attempting to seek
-            # past EOF. We need to ensure consistency for seeking past end of video with respect to
-            # errors and behaviour, and should probably gracefully stop at the last frame instead
-            # of throwing an exception.
+            # TODO(https://scenedetect.com/issues/380): Other backends do not currently throw an
+            # exception if attempting to seek past EOF.
+            #
+            # We need to ensure consistency for seeking past end of video with respect to errors and
+            # behaviour, and should probably gracefully stop at the last frame instead of throwing.
             if target >= self.duration:
                 raise SeekError("Target frame is beyond end of video!") from ex
             raise

scenedetect/backends/opencv.py

@@ -324,9 +324,9 @@ def _open_capture(self, framerate: ty.Optional[float] = None):
         cap.set(cv2.CAP_PROP_ORIENTATION_AUTO, 1.0)  # https://github.com/opencv/opencv/issues/26795
 
 
-# TODO(#168): Support non-monotonic timing for `position`. VFR timecode support is a
-# prerequisite for this. Timecodes are currently calculated by multiplying the framerate
-# by number of frames. Actual elapsed time can be obtained via `position_ms` for now.
+# TODO(https://scenedetect.com/issues/168): Support non-monotonic timing for `position`. VFR timecode
+# support is a prerequisite for this. Timecodes are currently calculated by multiplying the
+# framerate by number of frames. Actual elapsed time can be obtained via `position_ms` for now.
 class VideoCaptureAdapter(VideoStream):
     """Adapter for existing VideoCapture objects. Unlike VideoStreamCv2, this class supports
     VideoCaptures which may not support seeking.

scenedetect/backends/pyav.py

@@ -70,7 +70,8 @@ def __init__(
         """
         self._container = None
 
-        # TODO(#258): See what self._container.discard_corrupt = True does with corrupt videos.
+        # TODO(https://scenedetect.com/issues/258): See what `self._container.discard_corrupt = True`
+        # does with corrupt videos.
         super().__init__()
 
         # Ensure specified framerate is valid if set.

scenedetect/detectors/adaptive_detector.py

@@ -100,8 +100,6 @@ def get_metrics(self) -> ty.List[str]:
     def process_frame(
         self, timecode: FrameTimecode, frame_img: np.ndarray
     ) -> ty.List[FrameTimecode]:
-        # TODO(#283): Merge this with ContentDetector and turn it on by default.
-
         super().process_frame(timecode=timecode, frame_img=frame_img)
 
         # Initialize last scene cut point at the beginning of the frames of interest.

scenedetect/scene_manager.py

@@ -387,9 +387,9 @@ def _process_frame(
         """Add any cuts detected with the current frame to the cutting list. Returns True if any new
         cuts were detected, False otherwise."""
         new_cuts = False
-        # TODO(#283): This breaks with AdaptiveDetector as cuts differ from the frame number
-        # being processed. Allow detectors to specify the max frame lookahead they require
-        # (i.e. any event will never be more than N frames behind the current one).
+        # TODO(https://scenedetect.com/issues/283): This breaks with AdaptiveDetector as cuts differ
+        # from the frame number being processed. Allow detectors to specify the max frame lookahead
+        # they require (i.e. any event will never be more than N frames behind the current one).
         self._frame_buffer.append(frame_im)
         # frame_buffer[-1] is current frame, -2 is one behind, etc
         # so index based on cut frame should be [event_frame - (frame_num + 1)]

scenedetect/stats_manager.py

@@ -118,8 +118,8 @@ def register_metrics(self, metric_keys: ty.Iterable[str]) -> None:
         """Register a list of metric keys that will be used by the detector."""
         self._metric_keys = self._metric_keys.union(set(metric_keys))
 
-    # TODO(#507): This interface is difficult to use, we should support the dictionary protocol.
-    # Ideally this should work with Panadas. This could be done with the v0.7 API change.
+    # TODO(https://scenedetect.com/issues/507): We should support the dictionary protocol instead
+    # of using this bespoke interface. It would be useful for Pandas compatibility as well.
     def get_metrics(
         self, timecode: FrameTimecode, metric_keys: ty.Iterable[str]
     ) -> ty.List[ty.Any]:

tests/test_cli.py

@@ -520,7 +520,8 @@ def test_cli_save_images_path_handling(tmp_path: Path):
     assert image.shape == (544, 1280, 3)
 
 
-# TODO(#134): This works fine with OpenCV currently, but needs to be supported for PyAV and MoviePy.
+# TODO(https://scenedetect.com/issues/134): This works fine with OpenCV currently, but needs to be
+# supported for PyAV and MoviePy.
 def test_cli_save_images_rotation(rotated_video_file, tmp_path: Path):
     """Test that `save-images` command rotates images correctly with the default backend."""
     assert (

tests/test_detectors.py

@@ -41,10 +41,10 @@
 
 ALL_DETECTORS: ty.Tuple[ty.Type[SceneDetector]] = (*FAST_CUT_DETECTORS, ThresholdDetector)
 
-# TODO(#53): Add a test that verifies algorithms output relatively consistent frame scores
-# regardless of resolution. This will ensure that threshold values will hold true for different
-# input sources. Most detectors already provide this guarantee, so this is more to prevent any
-# regressions in the future.
+# TODO(https://scenedetect.com/issues/53): Add a test that verifies algorithms output relatively
+# consistent frame scores regardless of resolution. This will ensure that threshold values will hold
+# true for different input sources. Most detectors already provide this guarantee, so this is more
+# to prevent any regressions in the future.
 
 
 # TODO: Reduce code duplication here and in `conftest.py`