Skip to content

Commit d1224e2

Browse files
authored
Small wording fixes for docs (#226)
1 parent fc274bd commit d1224e2

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
[![codecov.io](http://codecov.io/github/JuliaArrays/StructArrays.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaArrays/StructArrays.jl?branch=master)
55
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaArrays.github.io/StructArrays.jl/stable)
66

7-
This package defined an array type, `StructArray`, which acts like an array of `struct` elements but which internally is stored as a list of arrays, typically one per field of the `struct`. See the [documentation](https://JuliaArrays.github.io/StructArrays.jl/stable) for details.
7+
This package defines an array type, `StructArray`, which acts like an array of `struct` elements but which internally is stored as a list of arrays, typically one per field of the `struct`. See the [documentation](https://JuliaArrays.github.io/StructArrays.jl/stable) for details.

docs/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ julia> x = StructArray((a = adata, b = bdata))
5050
It's also possible to create a `StructArray` by choosing a particular dimension to interpret as the components of a struct:
5151

5252
```jldoctest intro
53-
julia> x = StructArray{Complex{Int}}(adata; dims=1) # along dimension 1, odd indexes are `re` and even indexes are `im`
53+
julia> x = StructArray{Complex{Int}}(adata; dims=1) # along dimension 1, the first item `re` and the second is `im`
5454
2-element StructArray(view(::Matrix{Int64}, 1, :), view(::Matrix{Int64}, 2, :)) with eltype Complex{Int64}:
5555
1 + 3im
5656
2 + 4im
5757
58-
julia> x = StructArray{Complex{Int}}(adata; dims=2) # along dimension 2, odd indexes are `re` and even indexes are `im`
58+
julia> x = StructArray{Complex{Int}}(adata; dims=2) # along dimension 2, the first item `re` and the second is `im`
5959
2-element StructArray(view(::Matrix{Int64}, :, 1), view(::Matrix{Int64}, :, 2)) with eltype Complex{Int64}:
6060
1 + 2im
6161
3 + 4im

0 commit comments

Comments
 (0)