Skip to content

Commit 5ce0dc0

Browse files
authored
review documentation build with Julia 1.10 (#311)
review documentation build with Julia 1.10
1 parent 849dfad commit 5ce0dc0

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/src/index.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# A Julia Linear Operator Package
22

3-
Operators behave like matrices (with [exceptions](#Differences-1)) but are defined
3+
Operators behave like matrices (with [exceptions](@ref differences)) but are defined
44
by their effect when applied to a vector.
55
They can be transposed, conjugated, or combined with other operators cheaply.
66
The costly operation is deferred until multiplied with a vector.
77

88
## Compatibility
99

10-
Julia 1.3 and up.
10+
Julia 1.6 and up.
1111

1212
## How to Install
1313

@@ -68,21 +68,22 @@ operators (see [differences](@ref differences)).
6868
Unlike matrices, an operator never reduces to a vector or a number.
6969

7070
```@example exdiff
71-
using LinearOperators #hide
71+
using LinearOperators
7272
A = rand(5,5)
7373
opA = LinearOperator(A)
74-
A[:,1] * 3 # Vector
74+
A[:,1] * 3 isa Vector
7575
```
7676
```@example exdiff
77-
opA[:,1] * 3 # LinearOperator
77+
opA[:,1] * 3 isa LinearOperator
7878
```
7979
```@example exdiff
80-
# A[:,1] * [3] # ERROR
80+
opA[:,1] * [3] isa Vector
8181
```
82-
```@example exdiff
83-
opA[:,1] * [3] # Vector
82+
However, the following returns an error
83+
```julia
84+
A[:,1] * [3]
8485
```
85-
This is also true for `A[i,:]`, which returns vectors on Julia 0.6, and for the scalar
86+
This is also true for `A[i,:]`, which would return a vector and for the scalar
8687
`A[i,j]`.
8788
Similarly, `opA[1,1]` is an operator of size (1,1):"
8889
```@example exdiff

docs/src/tutorial.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
You can check an [Introduction to LinearOperators.jl](https://juliasmoothoptimizers.github.io/tutorials/introduction-to-linear-operators/) on our site, [juliasmoothoptimizers.github.io](https://juliasmoothoptimizers.github.io).
1+
You can check an [Introduction to LinearOperators.jl](https://jso.dev/tutorials/introduction-to-linear-operators/) on our site, [jso.dev](https://jso.dev/).

0 commit comments

Comments
 (0)