transform update for generic transforms #60
Conversation
| return transform; | ||
| } | ||
|
|
||
| pub struct AffineTransform { |
There was a problem hiding this comment.
I think this module is underdocumented so probably worth adding some either module level docs or type docs on the structs and public methods.
There was a problem hiding this comment.
Finally got around to updating this, added a bunch of comments, let me know what you think.
tdk-meta
force-pushed
the
master
branch
3 times, most recently
from
18c541d
to
9fe43f0
Compare
src/transform/affine.rs
Outdated
|
|
||
|
|
||
| pub fn transform_from_2dmatrix(in_array: Array2<f64>) -> AffineTransform { | ||
| /// converts a matrix into an equivalent Transform |
There was a problem hiding this comment.
Doc comments like this should be above the function signature.
src/transform/affine.rs
Outdated
| } | ||
|
|
||
| pub struct AffineTransform { | ||
| /// Represents a linear transform of either size 2x2 |
There was a problem hiding this comment.
Ditto, I imagine this comment should be above the struct? The idea is these should show up for users when they look at the docs (so run cargo doc and have a peruse to see how it looks)
|
@xd009642 happy to hear your feedback on this next round of comment polish. Also made ComposedTransform public |
|
The doc comments still seem to be below the function signatures instead of above them? |
|
Gah.. bad commit, sorry, should be working now. |
src/transform/mod.rs
Outdated
| impl Display for TransformError { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| match self { | ||
| InvalidTransform => return write!(f, "invalid transform" ), |
There was a problem hiding this comment.
I think here you should do Self::InvalidTransform that might fix CI
There was a problem hiding this comment.
Took TransformerError::InvalidTransform to pass tests... hopefully that works.
|
Okay just a |
Looking for Comments, Thanks