Skip to content

Commit 5776c43

Browse files
committed
Improve remove_link action docs
1 parent 3d30cbf commit 5776c43

3 files changed

Lines changed: 9 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Changelog
22

3+
## Latest
4+
* Improve remove_link action docs
5+
36
## 1.2.6
47
* 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.
58
* Avoid division by 0 in stalker under weird timer behaviour [#1035](https://github.com/membraneframework/membrane_core/pull/1035)

lib/membrane/bin/action.ex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,11 @@ defmodule Membrane.Bin.Action do
107107
| [Membrane.Child.group()]}
108108

109109
@typedoc """
110-
Action that removes link, which relates to specified child and pad.
110+
Action that removes link identified by child and its pad.
111111
112112
Removed link has to have dynamic pads on both ends.
113+
No matter whether input or output pad is passed,
114+
the whole link is always removed.
113115
"""
114116
@type remove_link :: {:remove_link, {Child.name(), Pad.ref()}}
115117

lib/membrane/pipeline/action.ex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,11 @@ defmodule Membrane.Pipeline.Action do
9696
{:remove_children, Child.name() | [Child.name()]}
9797

9898
@typedoc """
99-
Action that removes link, which relates to specified child and pad.
99+
Action that removes link identified by child and its pad.
100100
101101
Removed link has to have dynamic pads on both ends.
102+
No matter whether input or output pad is passed,
103+
the whole link is always removed.
102104
"""
103105
@type remove_link :: {:remove_link, {Child.name(), Pad.ref()}}
104106

0 commit comments

Comments
 (0)