Skip to content

Commit 06b9a29

Browse files
committed
Add docstring to select_b()
1 parent f2099b2 commit 06b9a29

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/src/components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ on_timer(rl::RateLimiter)
3333
```@docs
3434
Mixer_2CH
3535
Mixer_2CH(dt, t_blend)
36+
select_b(m2::Mixer_2CH, select_b::Bool)
3637
```
3738

3839
## Mixer_3CH

src/components.jl

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,8 +280,21 @@ function Mixer_2CH(dt, t_blend)
280280
Mixer_2CH(dt, t_blend, 0, false)
281281
end
282282

283+
"""
284+
select_b(m2::Mixer_2CH, select_b::Bool)
285+
286+
Select input a or b.
287+
288+
## Parameters
289+
- m2::Mixer_2CH: the two-channel mixer
290+
- select_b: if true, select channel b, otherwise select channel a
291+
292+
## Returns
293+
- nothing
294+
"""
283295
function select_b(m2::Mixer_2CH, select_b::Bool)
284296
m2.select_b = select_b
297+
nothing
285298
end
286299

287300
function on_timer(m2::Mixer_2CH)

0 commit comments

Comments
 (0)