diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ade2c8c5..fe32707f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/lib/membrane/bin/action.ex b/lib/membrane/bin/action.ex index d8612c59b..096142885 100644 --- a/lib/membrane/bin/action.ex +++ b/lib/membrane/bin/action.ex @@ -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()}} diff --git a/lib/membrane/pipeline/action.ex b/lib/membrane/pipeline/action.ex index 14d4ed637..7c8b21a6f 100644 --- a/lib/membrane/pipeline/action.ex +++ b/lib/membrane/pipeline/action.ex @@ -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()}}