Document when the function may panic

xiph · Sep 24, 2023 · 885ab24 · 885ab24
1 parent a3cfcb7
commit 885ab24
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/partition.rs b/src/partition.rs
@@ -374,6 +374,9 @@ impl BlockSize {
     })
   }
 
+  /// # Panics
+  ///
+  /// Will panic if the subsampling is not possible
   #[inline]
   pub fn largest_chroma_tx_size(self, xdec: usize, ydec: usize) -> TxSize {
     let plane_bsize = self