Skip to content

Commit 3927a9d

Browse files
committed
Improve docstrings in paths
1 parent 669680a commit 3927a9d

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

src/traversing/linear.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"""
66
LinearPath()
77
8-
Traverse a domain with `N` elements in order `1:N`.
8+
Traverse a domain with `n` elements in order `1:n`.
99
"""
1010
struct LinearPath <: Path end
1111

src/traversing/random.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"""
66
RandomPath()
77
8-
Traverse a domain with `N` elements in a random
9-
permutation of `1:N`.
8+
Traverse a domain with `n` elements in a random
9+
permutation of `1:n`.
1010
"""
1111
struct RandomPath{R<:AbstractRNG} <: Path
1212
rng::R

src/traversing/shifted.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"""
66
ShiftedPath(path, offset)
77
8-
Traverse a domain with the `path` shifted by an `offset`
9-
that can be positive or negative.
8+
Traverse a domain with the `path` shifted by an integer
9+
`offset` that can be positive or negative.
1010
"""
1111
struct ShiftedPath{P<:Path} <: Path
1212
path::P

0 commit comments

Comments
 (0)