Skip to content

Commit 55fd6ce

Browse files
committed
docs(core): fix docs
1 parent 73f7053 commit 55fd6ce

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

Diff for: src/matrices/index.jl

+3-3
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Groups `:builtin` and `:user` are special groups. It is suggested always to add
171171
See also [`remove_from_group`](@ref), [`remove_from_all_groups`](@ref).
172172
173173
# Examples
174-
```jldoctest
174+
```julia-repl
175175
julia> add_to_groups(Matrix, [Group(:user), Group(:test)])
176176
177177
julia> add_to_groups(Matrix, Group(:user), Group(:test))
@@ -210,7 +210,7 @@ Remove a matrix type from a group. If the group is empty, it will be deleted.
210210
See also [`add_to_groups`](@ref), [`remove_from_all_groups`](@ref).
211211
212212
# Examples
213-
```jldoctest
213+
```julia-repl
214214
julia> add_to_groups(Matrix, Group(:user))
215215
216216
julia> remove_from_group(Matrix, Group(:user))
@@ -256,7 +256,7 @@ Remove a matrix type from all groups. If a group is empty, it will be deleted.
256256
See also [`add_to_groups`](@ref), [`remove_from_group`](@ref).
257257
258258
# Examples
259-
```jldoctest
259+
```julia-repl
260260
julia> remove_from_all_groups(Matrix)
261261
```
262262
"""

Diff for: src/metadata.jl

+5-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const PROPERTIES = Dict{Type{<:PropertyTypes.AbstractProperty},Property}(
2424
List all properties.
2525
2626
# Examples
27-
```jldoctest
27+
```julia-repl
2828
julia> list_properties()
2929
9-element Vector{Property}:
3030
Property(:posdef)
@@ -36,6 +36,7 @@ julia> list_properties()
3636
Property(:graph)
3737
Property(:regprob)
3838
Property(:eigen)
39+
```
3940
"""
4041
list_properties() = collect(values(PROPERTIES))
4142

@@ -103,7 +104,7 @@ Register properties for a type. The properties are a vector of symbols.
103104
See also: [`properties`](@ref).
104105
105106
# Examples
106-
```jldoctest
107+
```julia-repl
107108
julia> @properties Matrix [:symmetric, :inverse, :illcond, :posdef, :eigen]
108109
```
109110
"""
@@ -166,7 +167,7 @@ Get the properties of a type or matrix.
166167
See also: [`@properties`](@ref).
167168
168169
# Examples
169-
```jldoctest
170+
```julia-repl
170171
julia> @properties Matrix [:symmetric, :posdef]
171172
172173
julia> properties(Matrix)
@@ -178,6 +179,7 @@ julia> properties(Matrix(ones(1, 1)))
178179
2-element Vector{Property}:
179180
Property(:symmetric)
180181
Property(:posdef)
182+
```
181183
"""
182184
properties(::Type{<:AbstractMatrix})::Vector{Property} = []
183185
properties(m::AbstractMatrix) = properties(typeof(m))

Diff for: src/types.jl

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ export
88
99
Types of properties.
1010
11+
See also [`Property`](@ref), [`list_properties`](@ref).
12+
1113
# Examples
12-
```jldoctest
14+
```julia-repl
1315
julia> PropertyTypes.Symmetric
1416
TypedMatrices.PropertyTypes.Symmetric
1517
```

0 commit comments

Comments
 (0)