From 885ab24ed25e0034cb7124d9ee8714ba2a13251c Mon Sep 17 00:00:00 2001
From: Luca Barbato <lu_zero@gentoo.org>
Date: Sun, 24 Sep 2023 13:11:15 +0200
Subject: [PATCH] Document when the function may panic

---
 src/partition.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/partition.rs b/src/partition.rs
index 92baf3293f..66320fe98c 100644
--- 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