Skip to content

Commit a16e873

Browse files
committed
Docs
1 parent 8118574 commit a16e873

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

src/systems/abstractsystem.jl

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -651,9 +651,41 @@ end
651651
check_name(name) = name isa Symbol || throw(Meta.ParseError("The lhs must be a symbol (a) or a ref (a[1:10]). Got $name."))
652652

653653
"""
654-
$(SIGNATURES)
654+
@named y = foo(x)
655+
@named y[1:10] = foo(x)
656+
@named y 1:10 i -> foo(x*i)
655657
656658
Rewrite `@named y = foo(x)` to `y = foo(x; name=:y)`.
659+
660+
Rewrite `@named y[1:10] = foo(x)` to `y = map(i′->foo(x; name=Symbol(:y_, i′)), 1:10)`.
661+
662+
Rewrite `@named y 1:10 i -> foo(x*i)` to `y = map(i->foo(x*i; name=Symbol(:y_, i)), 1:10)`.
663+
664+
Examples:
665+
```julia
666+
julia> using ModelingToolkit
667+
668+
julia> foo(i; name) = i, name
669+
foo (generic function with 1 method)
670+
671+
julia> x = 41
672+
41
673+
674+
julia> @named y = foo(x)
675+
(41, :y)
676+
677+
julia> @named y[1:3] = foo(x)
678+
3-element Vector{Tuple{Int64, Symbol}}:
679+
(41, :y_1)
680+
(41, :y_2)
681+
(41, :y_3)
682+
683+
julia> @named y 1:3 i -> foo(x*i)
684+
3-element Vector{Tuple{Int64, Symbol}}:
685+
(41, :y_1)
686+
(82, :y_2)
687+
(123, :y_3)
688+
```
657689
"""
658690
macro named(expr)
659691
name, call = split_assign(expr)

0 commit comments

Comments
 (0)