Skip to content

Commit 022f6df

Browse files
Merge pull request #288 from abhro/main
Add doctests and update docs
2 parents d87296a + 9ed2ff7 commit 022f6df

File tree

13 files changed

+80
-469
lines changed

13 files changed

+80
-469
lines changed

NEWS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ComponentArrays.jl NEWS
2-
Notes on new features (minor releases). For more details on bugfixes and non-feature-adding changes (patch releases), check out the [releases page](https://github.com/jonniedie/ComponentArrays.jl/releases).
2+
Notes on new features (minor releases). For more details on bugfixes and non-feature-adding changes (patch releases), check out the [releases page](https://github.com/SciML/ComponentArrays.jl/releases).
33

44
### v0.15.0
55
- Unpack array components as `StaticArray`s!
@@ -27,7 +27,7 @@ ComponentVector{Float64,SubArray...}(e = 2.0, f = [6.0, 30.0])
2727

2828
### v0.12.0
2929
- Multiple symbol indexing!
30-
- Use either an `Array` or `Tuple` of `Symbol`s to extract multiple named components into a new `ComponentArray
30+
- Use either an `Array` or `Tuple` of `Symbol`s to extract multiple named components into a new `ComponentArray`
3131
- It's fast!
3232
```julia
3333
julia> ca = ComponentArray(a=5, b=[4, 1], c=(a=2, b=[6, 30.0]))
@@ -118,7 +118,7 @@ julia> @btime sum(x.a + x.b for x in $ca.c.a);
118118
- Easier DifferentialEquations plotting!
119119
- Automatic legend labeling!
120120
- `Symbol` and `String` support for the `vars` plot keyword!
121-
- See it in an action [here](https://github.com/jonniedie/ComponentArrays.jl/blob/master/docs/src/examples/adaptive_control.md)!
121+
- See it in an action [here](https://github.com/SciML/ComponentArrays.jl/blob/main/docs/src/examples/adaptive_control.md)!
122122

123123
### v0.5.0
124124
- Constructor for making new `ComponentVector`s with additional fields! Watch out, it's slow!
@@ -131,7 +131,7 @@ ComponentVector{Int64}(a = 5, b = [1, 2], c = [0 0; 0 0], d = (a = 2, b = 10))
131131
```
132132

133133
### v0.4.0
134-
- Zygote rules for DiffEqFlux support! Check out [the docs](https://jonniedie.github.io/ComponentArrays.jl/dev/examples/DiffEqFlux/) for an example!
134+
- Zygote rules for DiffEqFlux support! Check out [the docs](https://sciml.github.io/ComponentArrays.jl/dev/examples/DiffEqFlux/) for an example!
135135

136136
### v0.3.0
137137
- Matrix and higher-dimensional array components!

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ComponentArrays.jl
22
![](assets/logo.png)
33

4-
| **Documentation** | **Build Status** |
5-
|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
4+
| **Documentation** | **Build Status** |
5+
|:-------------------------------------------------------------------------:|:-----------------------------------------------------------:|
66
| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][build-img]][build-url] [![][codecov-img]][codecov-url] |
77

88

@@ -12,11 +12,11 @@
1212
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
1313
[docs-stable-url]: https://sciml.github.io/ComponentArrays.jl/stable
1414

15-
[build-img]: https://img.shields.io/github/actions/workflow/status/jonniedie/ComponentArrays.jl/ci.yml
16-
[build-url]: https://github.com/jonniedie/docs/ComponentArrays.jl/workflows/ci.yml
15+
[build-img]: https://img.shields.io/github/actions/workflow/status/SciML/ComponentArrays.jl/ci.yml
16+
[build-url]: https://github.com/SciML/ComponentArrays.jl/actions/workflows/ci.yml
1717

18-
[codecov-img]: https://img.shields.io/codecov/c/github/jonniedie/ComponentArrays.jl
19-
[codecov-url]: https://codecov.io/gh/jonniedie/ComponentArrays.jl
18+
[codecov-img]: https://img.shields.io/codecov/c/github/SciML/ComponentArrays.jl
19+
[codecov-url]: https://codecov.io/gh/SciML/ComponentArrays.jl
2020

2121
The main export of this package is the ````ComponentArray```` type. "Components" of ````ComponentArray````s
2222
are really just array blocks that can be accessed through a named index. This will create a new ```ComponentArray``` whose data is a view into the original,
@@ -27,7 +27,7 @@ in [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl)
2727
[Optim.jl](https://github.com/JuliaNLSolvers/Optim.jl), but anything that requires
2828
flat vectors is fair game.
2929

30-
Check out the [NEWS](https://github.com/jonniedie/ComponentArrays.jl/blob/master/NEWS.md) for new features by minor release version.
30+
Check out the [NEWS](https://github.com/SciML/ComponentArrays.jl/blob/master/NEWS.md) for new features by minor release version.
3131

3232

3333
## General use
@@ -45,7 +45,7 @@ julia> x[8]
4545
400.0
4646

4747
julia> collect(x)
48-
10-element Array{Float64,1}:
48+
10-element Vector{Float64}:
4949
5.0
5050
20.0
5151
0.0

0 commit comments

Comments
 (0)