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

Docs: Clarify failure modes for loop commands #10

Closed
FelixMcFelix opened this issue Nov 16, 2020 · 0 comments · Fixed by #20
Closed

Docs: Clarify failure modes for loop commands #10

FelixMcFelix opened this issue Nov 16, 2020 · 0 comments · Fixed by #20
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers tracks Relates to audio control, state, or lifecycle management.
Milestone
v0.1.0: Initial R...

Comments

@FelixMcFelix
Copy link
Member

Currently, TrackHandle::enable_loop (and disable, etc.) are guaranteed to error on use against a non-seekable Input. This is implemented as a safety measure, but is not documented (encountered in #9).

Docs should be modified to explain this: by clearer commenting, and by ensuring the same guards exist on Tracks.
@FelixMcFelix FelixMcFelix added documentation Improvements or additions to documentation tracks Relates to audio control, state, or lifecycle management. labels Nov 16, 2020
@FelixMcFelix FelixMcFelix added this to the v0.1.0: Initial Release milestone Nov 16, 2020
@FelixMcFelix FelixMcFelix added the good first issue Good for newcomers label Nov 16, 2020
@peppizza peppizza mentioned this issue Nov 17, 2020
Closed
@FelixMcFelix FelixMcFelix mentioned this issue Nov 28, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers tracks Relates to audio control, state, or lifecycle management.
Projects
None yet
Milestone
v0.1.0: Initial Release
Development

Successfully merging a pull request may close this issue.

Cleanup of leaky types, nested results FelixMcFelix/songbird
1 participant
@FelixMcFelix