Skip to content

Commit fa5d776

Browse files
committed
docs(core): update docs
1 parent 8771acc commit fa5d776

File tree

2 files changed

+35
-29
lines changed

2 files changed

+35
-29
lines changed

src/matrices/index.jl

+13-9
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ MATRIX_GROUPS[GROUP_USER] = Set([])
150150
List all matrix groups.
151151
152152
# Examples
153-
```jldoctest
153+
```julia-repl
154154
julia> list_groups()
155155
2-element Vector{Group}:
156156
Group(:builtin)
@@ -172,13 +172,13 @@ See also [`remove_from_group`](@ref), [`remove_from_all_groups`](@ref).
172172
173173
# Examples
174174
```jldoctest
175-
julia> add_to_groups(Tridiagonal, [Group(:user), Group(:test)])
175+
julia> add_to_groups(Matrix, [Group(:user), Group(:test)])
176176
177-
julia> add_to_groups(Tridiagonal, Group(:user), Group(:test))
177+
julia> add_to_groups(Matrix, Group(:user), Group(:test))
178178
179-
julia> add_to_groups(Tridiagonal, [:user, :test])
179+
julia> add_to_groups(Matrix, [:user, :test])
180180
181-
julia> add_to_groups(Tridiagonal, :user, :test)
181+
julia> add_to_groups(Matrix, :user, :test)
182182
```
183183
"""
184184
function add_to_groups(type::Type{<:AbstractMatrix}, groups::Vector{Group})
@@ -211,9 +211,13 @@ See also [`add_to_groups`](@ref), [`remove_from_all_groups`](@ref).
211211
212212
# Examples
213213
```jldoctest
214-
julia> remove_from_group(Tridiagonal, Group(:user))
214+
julia> add_to_groups(Matrix, Group(:user))
215+
216+
julia> remove_from_group(Matrix, Group(:user))
215217
216-
julia> remove_from_group(Tridiagonal, :user)
218+
julia> add_to_groups(Matrix, :user)
219+
220+
julia> remove_from_group(Matrix, :user)
217221
```
218222
"""
219223
function remove_from_group(type::Type{<:AbstractMatrix}, group::Group)
@@ -253,7 +257,7 @@ See also [`add_to_groups`](@ref), [`remove_from_group`](@ref).
253257
254258
# Examples
255259
```jldoctest
256-
julia> remove_from_all_groups(Tridiagonal)
260+
julia> remove_from_all_groups(Matrix)
257261
```
258262
"""
259263
function remove_from_all_groups(type::Type{<:AbstractMatrix})
@@ -274,7 +278,7 @@ List all matrices that are in groups and have properties.
274278
`props` can be vector/varargs of `Property`, symbol, subtype of PropertyTypes.AbstractProperty or instance of AbstractProperty.
275279
276280
# Examples
277-
```jldoctest
281+
```julia-repl
278282
julia> list_matrices()
279283
42-element Vector{Type{<:AbstractMatrix}}:
280284
Fiedler

src/metadata.jl

+22-20
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ list_properties() = collect(values(PROPERTIES))
4545
Check properties types are valid, i.e., are subtypes of `PropertyTypes.AbstractProperty`.
4646
4747
# Examples
48-
```jldoctest
48+
```julia-repl
4949
julia> check_propertie_types(PropertyTypes.Symmetric, PropertyTypes.Inverse)
5050
5151
julia> check_propertie_types(Int)
@@ -64,7 +64,7 @@ end
6464
Check properties exists.
6565
6666
# Examples
67-
```jldoctest
67+
```julia-repl
6868
julia> check_properties_exists(Property(:symmetric), Property(:inverse))
6969
7070
julia> check_properties_exists(Property(:symmetric), Property(:notexists))
@@ -83,7 +83,7 @@ end
8383
Convert property types to properties.
8484
8585
# Examples
86-
```jldoctest
86+
```julia-repl
8787
julia> property_types_to_properties(PropertyTypes.Symmetric, PropertyTypes.Inverse)
8888
2-element Vector{Property}:
8989
Property(:symmetric)
@@ -100,9 +100,11 @@ end
100100
101101
Register properties for a type. The properties are a vector of symbols.
102102
103+
See also: [`properties`](@ref).
104+
103105
# Examples
104106
```jldoctest
105-
julia> @properties SymTridiagonal [:symmetric, :inverse, :illcond, :posdef, :eigen]
107+
julia> @properties Matrix [:symmetric, :inverse, :illcond, :posdef, :eigen]
106108
```
107109
"""
108110
macro properties(type::Symbol, ex::Expr)
@@ -119,20 +121,20 @@ Register properties for a type.
119121
See also: [`@properties`](@ref).
120122
121123
# Examples
122-
```jldoctest
123-
julia> register_properties(SymTridiagonal, [Property(:symmetric), Property(:inverse), Property(:illcond), Property(:posdef), Property(:eigen)])
124+
```julia-repl
125+
julia> register_properties(Matrix, [Property(:symmetric), Property(:inverse), Property(:illcond), Property(:posdef), Property(:eigen)])
124126
125-
julia> register_properties(SymTridiagonal, Property(:symmetric), Property(:inverse), Property(:illcond), Property(:posdef), Property(:eigen))
127+
julia> register_properties(Matrix, Property(:symmetric), Property(:inverse), Property(:illcond), Property(:posdef), Property(:eigen))
126128
127-
julia> register_properties(SymTridiagonal, [:symmetric, :inverse, :illcond, :posdef, :eigen])
129+
julia> register_properties(Matrix, [:symmetric, :inverse, :illcond, :posdef, :eigen])
128130
129-
julia> register_properties(SymTridiagonal, PropertyTypes.Symmetric, PropertyTypes.Inverse, PropertyTypes.IllCond, PropertyTypes.PosDef, PropertyTypes.Eigen)
131+
julia> register_properties(Matrix, PropertyTypes.Symmetric, PropertyTypes.Inverse, PropertyTypes.IllCond, PropertyTypes.PosDef, PropertyTypes.Eigen)
130132
131-
julia> register_properties(SymTridiagonal, [PropertyTypes.Symmetric, PropertyTypes.Inverse, PropertyTypes.IllCond, PropertyTypes.PosDef, PropertyTypes.Eigen])
133+
julia> register_properties(Matrix, [PropertyTypes.Symmetric, PropertyTypes.Inverse, PropertyTypes.IllCond, PropertyTypes.PosDef, PropertyTypes.Eigen])
132134
133-
julia> register_properties(SymTridiagonal, PropertyTypes.Symmetric(), PropertyTypes.Inverse(), PropertyTypes.IllCond(), PropertyTypes.PosDef(), PropertyTypes.Eigen())
135+
julia> register_properties(Matrix, PropertyTypes.Symmetric(), PropertyTypes.Inverse(), PropertyTypes.IllCond(), PropertyTypes.PosDef(), PropertyTypes.Eigen())
134136
135-
julia> register_properties(SymTridiagonal, [PropertyTypes.Symmetric(), PropertyTypes.Inverse(), PropertyTypes.IllCond(), PropertyTypes.PosDef(), PropertyTypes.Eigen()])
137+
julia> register_properties(Matrix, [PropertyTypes.Symmetric(), PropertyTypes.Inverse(), PropertyTypes.IllCond(), PropertyTypes.PosDef(), PropertyTypes.Eigen()])
136138
```
137139
"""
138140
function register_properties(T::Type, props::Vector{Property})
@@ -161,21 +163,21 @@ register_properties(T::Type, props::Vector{PropertyTypes.AbstractProperty}) = re
161163
162164
Get the properties of a type or matrix.
163165
166+
See also: [`@properties`](@ref).
167+
164168
# Examples
165169
```jldoctest
166-
julia> properties(Minij)
167-
4-element Vector{Property}:
170+
julia> @properties Matrix [:symmetric, :posdef]
171+
172+
julia> properties(Matrix)
173+
2-element Vector{Property}:
168174
Property(:symmetric)
169-
Property(:inverse)
170175
Property(:posdef)
171-
Property(:eigen)
172176
173-
julia> properties(Minij(5))
174-
4-element Vector{Property}:
177+
julia> properties(Matrix(ones(1, 1)))
178+
2-element Vector{Property}:
175179
Property(:symmetric)
176-
Property(:inverse)
177180
Property(:posdef)
178-
Property(:eigen)
179181
"""
180182
properties(::Type{<:AbstractMatrix})::Vector{Property} = []
181183
properties(m::AbstractMatrix) = properties(typeof(m))

0 commit comments

Comments
 (0)