[docs] Update detector docs.

Breakthrough · Jun 9, 2024 · 78b130b · 78b130b
1 parent ef47b0f
commit 78b130b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/docs/api/detectors.rst b/docs/api/detectors.rst
@@ -8,10 +8,16 @@ Detection Algorithms
 .. automodule:: scenedetect.detectors
    :members:
 
+.. automodule:: scenedetect.detectors.adaptive_detector
+   :members:
+
 .. automodule:: scenedetect.detectors.content_detector
    :members:
 
-.. automodule:: scenedetect.detectors.adaptive_detector
+.. automodule:: scenedetect.detectors.hash_detector
+   :members:
+
+.. automodule:: scenedetect.detectors.histogram_detector
    :members:
 
 .. automodule:: scenedetect.detectors.threshold_detector

diff --git a/scenedetect/_cli/__init__.py b/scenedetect/_cli/__init__.py
@@ -756,7 +756,7 @@ def detect_threshold_command(
 @click.pass_context
 def detect_hist_command(ctx: click.Context, threshold: Optional[float], bins: Optional[int],
                         min_scene_len: Optional[str]):
-    """Finds fast cuts by differencing YUV histograms.
+    """Find fast cuts by differencing YUV histograms.
 
     Uses Y channel after converting each frame to YUV to create a histogram of each frame.
     Histograms between frames are compared to determine a score for how similar they are.

diff --git a/website/pages/changelog.md b/website/pages/changelog.md
@@ -23,6 +23,7 @@ Includes new histogram and perceptual hash based detectors (thanks @wjs018 and @
  - [feature] Add more templates for `save-images` filename customization: `$TIMECODE`, `$FRAME_NUMBER`, `$TIMESTAMP_MS` (thanks @Veldhoen0) [#395](https://github.com/Breakthrough/PySceneDetect/pull/395)
  - [bugfix] Remove extraneous console output when using `--drop-short-scenes`
  - [bugfix] Fix scene lengths being smaller than `min-scene-len` when using `detect-adaptive` / `AdaptiveDetector` with large values of `--frame-window`
+ - [bugfix] Fix crash when decoded frames have incorrect resolution and log error instead [#319](https://github.com/Breakthrough/PySceneDetect/issues/319)
  - [bugfix] Update default ffmpeg stream mapping from `-map 0` to `-map 0:v:0 -map 0:a? -map 0:s?` [#392](https://github.com/Breakthrough/PySceneDetect/issues/392)