Modify the doc comment of 'floatingPanel(_:shouldAllowToScroll:in:)'

scenee · Oct 8, 2023 · 046ed3d · 046ed3d
1 parent 4996ce1
commit 046ed3d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/Sources/Controller.swift b/Sources/Controller.swift
@@ -116,6 +116,9 @@ import os.log
     ///     return state == .full || state == .half
     /// }
     /// ```
+    ///
+    /// - Attention: It is recommended that this method always returns the most expanded state(i.e.
+    /// .full). If it excludes the state, the panel might do unexpected behaviors.
     @objc(floatingPanel:shouldAllowToScroll:in:)
     optional func floatingPanel(
         _ fpc: FloatingPanelController,