[docs] Regenerate CLI docs

Author: Breakthrough

docs/cli.rst

@@ -178,8 +178,6 @@ Options
 
   Default: ``15.0``
 
-
-
 .. option:: -f VAL, --frame-window VAL
 
   Size of window to detect deviations from mean. Represents how many frames before/after the current one to use for mean.
@@ -552,6 +550,38 @@ Options
   Output directory to save EDL file to. Overrides global option :option:`-o/--output <scenedetect -o>`.
 
 
+.. _command-save-fcp:
+
+.. program:: scenedetect save-fcp
+
+
+``save-fcp``
+========================================================================
+
+Save cuts in Final Cut Pro XML format (FCP7 xmeml or FCPX).
+
+
+Options
+------------------------------------------------------------------------
+
+
+.. option:: -f NAME, --filename NAME
+
+  Filename format to use.
+
+  Default: ``$VIDEO_NAME.xml``
+
+.. option:: --format TYPE
+
+  Format to export. TYPE must be one of: fcpx, fcp7.
+
+  Default: ``FcpFormat.FCPX``
+
+.. option:: -o DIR, --output DIR
+
+  Output directory to save XML file to. Overrides global option :option:`-o/--output <scenedetect -o>`.
+
+
 .. _command-save-html:
 
 .. program:: scenedetect save-html
@@ -658,11 +688,11 @@ Options
 
   Default: ``3``
 
-.. option:: -m N, --frame-margin N
+.. option:: -m DURATION, --frame-margin DURATION
 
-  Number of frames to ignore at beginning/end of scenes when saving images. Controls temporal padding on scene boundaries.
+  Padding around the beginning/end of each scene used when selecting which frames to extract. DURATION can be specified in frames (-m 1), in seconds with `s` suffix (-m 0.1s), or timecode (-m 00:00:00.100).
 
-  Default: ``3``
+  Default: ``1``
 
 .. option:: -s S, --scale S
 

docs/generate_cli_docs.py

@@ -116,7 +116,7 @@ def add_backquotes_with_refs(refs: ty.Set[str]) -> ty.Callable[[str], str]:
 
     def _add_backquotes(s: re.Match) -> str:
         to_add: str = s.string[s.start() : s.end()]
-        flag = re.search("-+[\w-]+[^\.\=\s\/]*", to_add)
+        flag = re.search(r"-+[\w-]+[^\.\=\s\/]*", to_add)
         if flag is not None and flag.string[flag.start() : flag.end()] in refs:
             # add cross reference
             cross_ref = flag.string[flag.start() : flag.end()]
@@ -129,7 +129,7 @@ def _add_backquotes(s: re.Match) -> str:
 
 
 def extract_default_value(s: str) -> ty.Tuple[str, ty.Optional[str]]:
-    default = re.search("\[default: .*\]", s)
+    default = re.search(r"\[default: .*\]", s)
     if default is not None:
         span = default.span()
         assert span[1] == len(s)
@@ -145,11 +145,11 @@ def transform_add_option_refs(s: str, refs: ty.List[str]) -> str:
     # TODO: Match prefix of `global option` and add ref to parent `scenedetect` command option.
     # Replace patch to complete this.
     #  -c/--command
-    s = re.sub("-\w/--\w[\w-]*", transform, s)
+    s = re.sub(r"-\w/--\w[\w-]*", transform, s)
     #  --arg=value, --arg=1.2.3, --arg=1,2,3
-    s = re.sub('-+[\w-]+=[^"\s\)]+(?<![\.\,])', transform, s)
+    s = re.sub(r'-+[\w-]+=[^"\s\)]+(?<![\.\,])', transform, s)
     # --args=" command with spaces"
-    s = re.sub('--[\w-]+[=]+".*?"', transform, s)
+    s = re.sub(r'--[\w-]+[=]+".*?"', transform, s)
     return s