Skip to content

Improve remove_link action docs #1048

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

Merged
mat-hek merged 1 commit into from
Jan 13, 2026
Merged

Improve remove_link action docs #1048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Changelog

## Latest
* Improve remove_link action docs

## 1.2.6
* Add tutorials [#1007](https://github.com/membraneframework/membrane_core/pull/1007), plugins [#1012](https://github.com/membraneframework/membrane_core/pull/1012) and demos [#1013](https://github.com/membraneframework/membrane_core/pull/1013) to the docs.
* Avoid division by 0 in stalker under weird timer behaviour [#1035](https://github.com/membraneframework/membrane_core/pull/1035)
Expand Down
4 changes: 3 additions & 1 deletion lib/membrane/bin/action.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,11 @@ defmodule Membrane.Bin.Action do
| [Membrane.Child.group()]}

@typedoc """
Action that removes link, which relates to specified child and pad.
Action that removes link identified by child and its pad.

Removed link has to have dynamic pads on both ends.
No matter whether input or output pad is passed,
the whole link is always removed.
"""
@type remove_link :: {:remove_link, {Child.name(), Pad.ref()}}

Expand Down
4 changes: 3 additions & 1 deletion lib/membrane/pipeline/action.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,11 @@ defmodule Membrane.Pipeline.Action do
{:remove_children, Child.name() | [Child.name()]}

@typedoc """
Action that removes link, which relates to specified child and pad.
Action that removes link identified by child and its pad.

Removed link has to have dynamic pads on both ends.
No matter whether input or output pad is passed,
the whole link is always removed.
"""
@type remove_link :: {:remove_link, {Child.name(), Pad.ref()}}

Expand Down
Loading