Skip to content

Commit f29ce22

Browse files
committed
Expand docstring
1 parent 1b3e1e2 commit f29ce22

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/features.jl

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,17 @@ end
167167
"""
168168
mgmm = features_from_structure(seq::ChainLike, ρmax::Real, zi::AbstractInterval)
169169
170-
Construct an `IsotropicMultiGMM` from `seq` including all atoms that lie within the cylinder
170+
Construct an `IsotropicMultiGMM` from `seq` including all atoms that lie within
171+
the cylinder
171172
172173
x^2 + y^2 <= ρmax^2
173174
z ∈ zi
175+
176+
`zi` is an `AbstractInterval`, e.g. `0..30` or `-15..15` (see IntervalSets.jl).
177+
178+
This implicitly assumes that you've aligned `seq` to the membrane, or aligned
179+
`seq` to a homolog that is membrane-aligned. See [`align_to_membrane`](@ref),
180+
[`align`](@ref).
174181
"""
175182
function features_from_structure(
176183
seq, ρmax::Real, zi::AbstractInterval;

0 commit comments

Comments
 (0)