Skip to content

Commit b645d82

Browse files
committed
update docstrings
1 parent 6e190be commit b645d82

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/NetworkLayout.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ using GeometryBasics
66
using LinearAlgebra: norm
77

88
"""
9-
abstract type AbstractLayout{Dim,Ptype} end
9+
AbstractLayout{Dim,Ptype}
1010
11-
Supertype for all layouts. Each layout `Algorithm <: AbstractLayout` needs to
11+
Abstract supertype for all layouts. Each layout `Algorithm <: AbstractLayout` needs to
1212
implement
1313
1414
layout(algo::Algorithm, adj_matrix)::Vector{Point{Dim,Ptype}}
@@ -28,9 +28,9 @@ ptype(::AbstractLayout{Dim,Ptype}) where {Dim,Ptype} = Ptype
2828
(lay::AbstractLayout)(adj_matrix) = layout(lay, adj_matrix)
2929

3030
"""
31-
abstract type IterativeLayout{Dim,Ptype} <: AbstractLayout{Dim,Ptype} end
31+
IterativeLayout{Dim,Ptype} <: AbstractLayout{Dim,Ptype}
3232
33-
Supertype for iterative layouts. Instead of implementing `layout` directly,
33+
Abstract supertype for iterative layouts. Instead of implementing `layout` directly,
3434
subtypes `Algorithm<:IterativeLayout` need to implement the [iterator
3535
interface](https://docs.julialang.org/en/v1/manual/interfaces/#man-interface-iteration)
3636
@@ -49,7 +49,7 @@ function-like call
4949
abstract type IterativeLayout{Dim,Ptype} <: AbstractLayout{Dim,Ptype} end
5050

5151
"""
52-
LayoutIterator(algorithm::IterativeLayout, adj_matrix)
52+
LayoutIterator{T<:IterativeLayout,M<:AbstractMatrix}(algorithm, adj_matrix)
5353
5454
This type bundles an [`IterativeLayout`](@ref) with an adjacency matrix to form an
5555
iterable object whose items are the node positions.

0 commit comments

Comments
 (0)