based_aa: Update docstrings

Jaded-Encoding-Thaumaturgy · Sep 24, 2024 · 2679453 · 2679453
1 parent 5fac071
commit 2679453
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/vsaa/funcs.py b/vsaa/funcs.py
@@ -346,18 +346,21 @@ def based_aa(
                                 introducing too much ringing.
                                 Default: ArtCNN.C16F64.
         :param eedi3_kwargs:    Keyword arguments to pass on to EEDI3.
-        :param prefilter:       Prefilter to apply before anti-aliasing. Default: None.
+        :param prefilter:       Prefilter to apply before anti-aliasing.
+                                Must be a VideoNode, a function that takes a VideoNode and returns a VideoNode,
+                                or None. Default: None.
         :param postfilter:      Postfilter to apply after anti-aliasing.
-                                If None, will apply a median filtered bilateral smoother to clean halos.
-                                Default: None.
+                                Must be a function that takes a VideoNode and returns a VideoNode, or None.
+                                If None, applies a median-filtered bilateral smoother to clean halos
+                                created during antialiasing. Default: None.
         :param show_mask:       If True, returns the edge detection mask instead of the processed clip.
                                 Default: False
         :param planes:          Planes to process. Default: Luma only.
 
         :return:                Anti-aliased clip or edge detection mask if show_mask is True.
 
         :raises CustomRuntimeError:     If required packages are missing.
-        :raises CustomValueError:       If rfactor is not above 0.0.
+        :raises CustomValueError:       If rfactor is not above 0.0, or invalid prefilter/postfilter is passed.
         """
 
         ...