Skip to content

Commit 2d66c09

Browse files
committed
Add type headers to type docstrings
1 parent 1527061 commit 2d66c09

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/core.jl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
# transform_deriv() and transform_deriv_params()
77

88
"""
9+
abstract type Transformation
10+
911
The `Transformation` supertype defines a simple interface for performing
1012
transformations. Subtypes should be able to apply a coordinate system
1113
transformation on the correct data types by overloading the call method, and
@@ -15,6 +17,8 @@ Efficient compositions can optionally be defined by `compose()` (equivalently `
1517
abstract type Transformation end
1618

1719
"""
20+
IdentityTransformation <: Transformation
21+
1822
The `IdentityTransformation` is a singleton `Transformation` that returns the
1923
input unchanged, similar to `identity`.
2024
"""
@@ -23,8 +27,10 @@ struct IdentityTransformation <: Transformation; end
2327
@inline (::IdentityTransformation)(x) = x
2428

2529
"""
26-
A `ComposedTransformation` simply executes two transformations successively, and
27-
is the fallback output type of `compose()`.
30+
ComposedTransformation{T1, T2} <: Transformation
31+
32+
A `ComposedTransformation` simply executes two transformations `T2` and `T1`
33+
successively, and is the fallback output type of `compose()`.
2834
"""
2935
struct ComposedTransformation{T1 <: Transformation, T2 <: Transformation} <: Transformation
3036
t1::T1

0 commit comments

Comments
 (0)