Skip to content

Commit 8f10e89

Browse files
committed
docs(core): update list interfaces docs
1 parent aa42aa8 commit 8f10e89

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Diff for: src/matrices/index.jl

+12-8
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,13 @@ list_groups() = collect(keys(MATRIX_GROUPS))
162162
"""
163163
add_to_groups(type, groups)
164164
165-
Add a matrix type to groups.
165+
Add a matrix type to groups. If a group is not exists, it will be created.
166166
167-
groups can be vector/varargs of `Group` or symbol.
167+
Groups `:builtin` and `:user` are special groups. It is suggested always to add matrices to the `:user` group.
168+
169+
`groups` can be vector/varargs of `Group` or symbol.
170+
171+
See also [`remove_from_group`](@ref), [`remove_from_all_groups`](@ref).
168172
169173
# Examples
170174
```jldoctest
@@ -201,9 +205,9 @@ add_to_groups(type::Type{<:AbstractMatrix}, groups::Vector{Symbol}) = add_to_gro
201205
"""
202206
remove_from_group(type, group)
203207
204-
Remove a matrix type from a group.
208+
Remove a matrix type from a group. If the group is empty, it will be deleted.
205209
206-
See also [`remove_from_all_groups`](@ref).
210+
See also [`add_to_groups`](@ref), [`remove_from_all_groups`](@ref).
207211
208212
# Examples
209213
```jldoctest
@@ -243,9 +247,9 @@ remove_from_group(type::Type{<:AbstractMatrix}, group::Symbol) = remove_from_gro
243247
"""
244248
remove_from_all_groups(type)
245249
246-
Remove a matrix type from all groups.
250+
Remove a matrix type from all groups. If a group is empty, it will be deleted.
247251
248-
See also [`remove_from_group`](@ref).
252+
See also [`add_to_groups`](@ref), [`remove_from_group`](@ref).
249253
250254
# Examples
251255
```jldoctest
@@ -265,9 +269,9 @@ end
265269
266270
List all matrices that are in groups and have properties.
267271
268-
groups can be vector/varargs of `Group` or symbol.
272+
`groups` can be vector/varargs of `Group` or symbol.
269273
270-
props can be vector/varargs of `Property`, symbol, data type or property type.
274+
`props` can be vector/varargs of `Property`, symbol, subtype of PropertyTypes.AbstractProperty or instance of AbstractProperty.
271275
272276
# Examples
273277
```jldoctest

0 commit comments

Comments
 (0)