doc: update SetFrameProp docs

and suggest users to look into SetFrameProps and RemoveFrameProps APIs. Fixes vapoursynth#736. Signed-off-by: akarin <[email protected]>
AkarinVS · Sep 2, 2021 · 8abd15e · 8abd15e
1 parent ed6946d
commit 8abd15e
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/doc/functions/setframeprop.rst b/doc/functions/setframeprop.rst
@@ -1,10 +1,10 @@
 SetFrameProp
 ============
 
-.. function:: SetFrameProp(vnode clip, string prop[, int[] intval, float[] floatval, string[] data])
+.. function:: SetFrameProp(vnode clip, string prop[, bint delete=False, int[] intval, float[] floatval, string[] data])
    :module: std
 
-   Adds a frame property to every frame in *clip*.
+   Adds/deletes a frame property to every frame in *clip*.
 
    If there is already a property with the name *prop* in the frames,
    it will be overwritten.
@@ -18,3 +18,7 @@ SetFrameProp
    For example, to set the field order to top field first::
 
       clip = c.std.SetFrameProp(clip, prop="_FieldBased", intval=2)
+
+   For users not requiring compatibility with R54 or older VapourSynth releases, it
+   is recommended to use the more intuitive *SetFrameProps* and *RemoveFrameProps*
+   functions instead.