add descriptions to DownsampleVideo sub class schemas

AllenInstitute · Jan 25, 2022 · 325c5fb · 325c5fb
1 parent 95e329d
commit 325c5fb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/src/ophys_etl/modules/downsample_video/side_by_side_video.py b/src/ophys_etl/modules/downsample_video/side_by_side_video.py
@@ -13,12 +13,16 @@ class SideBySideDownsamplerSchema(DownsampleBaseSchema):
     left_video_path = argschema.fields.InputFile(
            required=True,
            default=None,
-           allow_none=False)
+           allow_none=False,
+           description=("Path to the input video to be displayed "
+                        "in the left panel of the output video"))
 
     right_video_path = argschema.fields.InputFile(
             required=True,
             default=None,
-            allow_none=False)
+            allow_none=False,
+            description=("Path to the input video to be displayed "
+                         "in the right panel of the output video"))
 
 
 class SideBySideDownsampler(argschema.ArgSchemaParser):

diff --git a/src/ophys_etl/modules/downsample_video/single_video.py b/src/ophys_etl/modules/downsample_video/single_video.py
@@ -13,7 +13,8 @@ class VideoDownsamplerSchema(DownsampleBaseSchema):
     video_path = argschema.fields.InputFile(
            required=True,
            default=None,
-           allow_none=False)
+           allow_none=False,
+           description="Path to the input video file")
 
 
 class VideoDownsampler(argschema.ArgSchemaParser):