Skip to content

Remove erroneous LVector docstring and point user to the alternative that works. #154

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
merged 3 commits into from
Feb 3, 2024
Merged

Remove erroneous LVector docstring and point user to the alternative that works. #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aceca0f
Remove erroneous docstring and point user to the alternative that works.
alecloudenback Feb 3, 2024
a13e955
Add test that confirms old docstring was broken
alecloudenback Feb 3, 2024
18ed11b
fix typo
alecloudenback Feb 3, 2024
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
6 changes: 3 additions & 3 deletions src/larray.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,11 +271,11 @@ A = @LVector Float64 (:a, :b, :c, :d)
A .= rand(4)
```

On the other hand, users can also initialize the vector and set its values at the
same time:
To initialize the vector and set its values at the
same time, use [`@LArray`](@ref) instead:

```julia
b = @LVector [1, 2, 3] (:a, :b, :c)
b = @LArray [1, 2, 3] (:a, :b, :c)
```
"""
macro LVector(type, syms)
Expand Down
3 changes: 3 additions & 0 deletions test/larrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ using LabelledArrays, Test, InteractiveUtils
@test vcat(x, y) == [1, 2, 3, 4, 5, 6]

@test_throws ErrorException x.z

# Ref #93, #154
@test_broken @LVector [1, 2, 3] (:a, :b, :c)
end

@testset "Alternate array backends" begin
Expand Down