Refactor child pad removed default error message #581
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
FelonEkonom
added
the
no-changelog
mat-hek
requested changes
Jul 19, 2023
lib/membrane/core/parent.ex
Outdated
| callback_ref = "`c:Membrane.#{component_type_string}.handle_child_pad_removed/4`" | ||
|
|
||
| """ | ||
| Child #{inspect(child)} removed its pad #{inspect(pad)}, but callback #{callback_ref} is not implemented in #{inspect(component_module)}. |
There was a problem hiding this comment.
Suggested change
| Child #{inspect(child)} removed its pad #{inspect(pad)}, but callback #{callback_ref} is not implemented in #{inspect(component_module)}. | |
| Bin #{inspect(child)} removed its pad #{inspect(pad)}, but callback #{callback_ref} is not implemented in #{inspect(component_module)}. |
lib/membrane/core/parent.ex
Outdated
| """ | ||
| Child #{inspect(child)} removed its pad #{inspect(pad)}, but callback #{callback_ref} is not implemented in #{inspect(component_module)}. | ||
|
|
||
| This means, that `#{inspect(child)} is a bin, that removed its pad #{inspect(pad)} on its own, without knowledge of its parent. It |
There was a problem hiding this comment.
Suggested change
| This means, that `#{inspect(child)} is a bin, that removed its pad #{inspect(pad)} on its own, without knowledge of its parent. It | |
| This means, that `#{inspect(child)} removed the pad on its own, without knowledge of its parent. It |
lib/membrane/core/parent.ex
Outdated
| could be done, by, for example, removing #{inspect(child)}'s child linked to the #{inspect(child)}'s inner pad or by removing link | ||
| between #{inspect(child)} and its child. | ||
|
|
||
| If you want to handle e scenario when a child removes its pad in #{inspect(component_module)}, implement #{callback_ref} callback. |
There was a problem hiding this comment.
Suggested change
| If you want to handle e scenario when a child removes its pad in #{inspect(component_module)}, implement #{callback_ref} callback. | |
| If you want to handle this scenario, implement #{callback_ref} callback in #{inspect(component_module)}. |
lib/membrane/core/parent.ex
Outdated
Comment on lines
20
to
21
| could be done, by, for example, removing #{inspect(child)}'s child linked to the #{inspect(child)}'s inner pad or by removing link | ||
| between #{inspect(child)} and its child. |
There was a problem hiding this comment.
Suggested change
| could be done, by, for example, removing #{inspect(child)}'s child linked to the #{inspect(child)}'s inner pad or by removing link | |
| between #{inspect(child)} and its child. | |
| may have happened because, for example, #{inspect(child)} removed its child linked to its inner pad or unlinked its child from its inner pad. |
FelonEkonom
force-pushed
the
refactor-child-pad-removed-error-message
branch
from
9cd94d2
to
7f6ac6d
Compare
…removed-error-message
varsill
reviewed
Jul 20, 2023
Co-authored-by: Łukasz Kita <lukasz.kita0@gmail.com>
varsill
approved these changes
Jul 21, 2023
| msg = """ | ||
| Bin #{inspect(child)} removed its pad #{inspect(pad)}, but callback #{callback_ref} is not implemented in #{inspect(module)}. | ||
|
|
||
| This means, that `#{inspect(child)} removed the pad on its own, without knowledge of its parent. For example it could happen due to removing #{inspect(child)}'s child linked to the #{inspect(child)}'s inner pad or by removing link between #{inspect(child)} and its child. |
There was a problem hiding this comment.
shouldn't we split it into two lines?
…removed-error-message
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.
Related Jira ticket: https://membraneframework.atlassian.net/browse/MC-214