Skip to content

Commit b15ab4f

Browse files
committed
docs: add docstrings
1 parent b28968a commit b15ab4f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

videodb/timeline_v2.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44

55
class AssetType(str, Enum):
6+
"""The type of asset to display for the duration of the Clip."""
7+
68
video = "video"
79
image = "image"
810
audio = "audio"
@@ -11,12 +13,16 @@ class AssetType(str, Enum):
1113

1214

1315
class Fit(str, Enum):
16+
"""The fit mode to apply to the asset."""
17+
1418
crop = "crop"
1519
cover = "cover"
1620
contain = "contain"
1721

1822

1923
class Position(str, Enum):
24+
"""The position of the asset on the timeline."""
25+
2026
top = "top"
2127
bottom = "bottom"
2228
left = "left"
@@ -547,7 +553,7 @@ def to_json(self):
547553

548554

549555
class Clip:
550-
"""A clip is a container for a specific type of asset, i.e. a title, image, video, audio or html. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it."""
556+
"""A clip is a container for a specific type of asset, i.e. a title, image, video, audio or caption. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it."""
551557

552558
def __init__(
553559
self,

0 commit comments

Comments
 (0)