Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update doc string for otio.algorithms.track_with_expanded_transitions() to clarify the returned list #793

Closed
1 of 2 tasks
apetrynet opened this issue Sep 4, 2020 · 0 comments · Fixed by #794
Closed
1 of 2 tasks

Update doc string for otio.algorithms.track_with_expanded_transitions() to clarify the returned list #793

apetrynet opened this issue Sep 4, 2020 · 0 comments · Fixed by #794
Milestone
Public Beta 14

Comments

@apetrynet
Copy link
Contributor

Feature Request

  • New Feature
  • Change Existing Behavior

Description

The current doc string for otio.algorithms.track_with_expanded_transitions() indicates the function returns a "pure" list of items (Clip's, Transition, etc.). This is not the case. The items involved in the transition are encapsulated in tuples.
We should perhaps update the doc string to clarify this.

Context

When using the otio.algorithms.track_with_expanded_transitions() I got surprised by the parts of a transition being encapsulated in tuples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Public Beta 14
Development

Successfully merging a pull request may close this issue.

Update doc string for otio.algorithms.track_with_expanded_transitions() apetrynet/OpenTimelineIO
2 participants
@jminor @apetrynet