Improve callbacks return types #702
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
….handle_init/2`. Fix a missleading information in docs about returning `:latency` action from `Membrane.Element.Base.handle_init`
mat-hek
reviewed
Jan 8, 2024
lib/membrane/bin/action.ex
Outdated
| @@ -13,9 +13,10 @@ defmodule Membrane.Bin.Action do | |||
| @typedoc """ | |||
| Action that manages the end of the component setup. | |||
|
|
|||
| By default, component setup ends with the end of `c:Membrane.Bin.handle_setup/2` callback. | |||
| By default, component setup ends with the end of callback. | |||
| | end_of_stream | ||
| | terminate | ||
| | redemand |
lib/membrane/element/action.ex
Outdated
| Depending on element type, callback, current playback and other | ||
| circumstances there may be different actions available. | ||
| """ | ||
|
|
lib/membrane/element/action.ex
Outdated
| | redemand | ||
|
|
||
| @typedoc """ | ||
| Type that defines a union of actions that may be returned from some element callbacks. |
There was a problem hiding this comment.
Suggested change
| Type that defines a union of actions that may be returned from some element callbacks. | |
| Type that defines a union of actions that may be returned from most of the element callbacks. |
| Type that defines a union of actions that may be returned from some element callbacks. | ||
|
|
||
| Depending on element type, callback, current playback and other | ||
| circumstances there may be different actions available. |
There was a problem hiding this comment.
Suggested change
| circumstances there may be different actions available. | |
| circumstances there may be different actions available. | |
| Check the typespec and documentation of particular callbacks | |
| for details. |
lib/membrane/element/base.ex
Outdated
Comment on lines
36
to
40
| # @typedoc """ | ||
| # Type that defines all valid return values from most callbacks. | ||
| # """ | ||
| # @type callback_return :: {[Action.t()], Element.state()} | ||
|
|
There was a problem hiding this comment.
Suggested change
| # @typedoc """ | |
| # Type that defines all valid return values from most callbacks. | |
| # """ | |
| # @type callback_return :: {[Action.t()], Element.state()} |
mat-hek
approved these changes
Jan 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.