New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and Design: Transform2D #296

Closed
maxsnew opened this Issue Jul 15, 2015 · 4 comments

Comments

Projects
None yet
3 participants
@maxsnew
Contributor

maxsnew commented Jul 15, 2015

I think the Transform2D documentation is overly technical in that it emphasizes the underlying matrix representation too much. Here's a link for convenience http://package.elm-lang.org/packages/elm-lang/core/2.1.0/Transform2D.

Even people familliar with some linear algebra might not be familiar with affine transformations and their representation as 3x3 matrices where the bottom row is (0 0 1).

Most of it is pretty straightforward and easily explained but the really bad one in my opinion is "Multiplication" which doesn't even mention that multiplication of these matrices really means composition of the transformations that they represent. I think this function should be renamed to compose.

Also can we have pictures in documentation? They might be helpful here but maybe that's just over-complicating things.

I'd be willing to work on this but I wanted to discuss it first esp. since it's a proposed API change.

@texastoland

This comment has been minimized.

Show comment
Hide comment
@texastoland

texastoland Jul 15, 2015

I have a similar concern in another package. Two considerations:

  1. Do their type signature match any more generic functions you could borrow (or apply back) inspiration from?
  2. Are you familiar with any library on another platform that has tried this?

texastoland commented Jul 15, 2015

I have a similar concern in another package. Two considerations:

  1. Do their type signature match any more generic functions you could borrow (or apply back) inspiration from?
  2. Are you familiar with any library on another platform that has tried this?
@maxsnew

This comment has been minimized.

Show comment
Hide comment
@maxsnew

maxsnew Jul 15, 2015

Contributor

@dnalot Could you clarify what you mean by 2?

Contributor

maxsnew commented Jul 15, 2015

@dnalot Could you clarify what you mean by 2?

@texastoland

This comment has been minimized.

Show comment
Hide comment
@texastoland

texastoland Jul 15, 2015

Just searching if anyone outside Elm has set precedent we could borrow for intuitively naming graphical operations.

texastoland commented Jul 15, 2015

Just searching if anyone outside Elm has set precedent we could borrow for intuitively naming graphical operations.

@evancz

This comment has been minimized.

Show comment
Hide comment
@evancz

evancz May 11, 2016

Member

This lives in evancz/elm-graphics now, but I also would prefer to keep the API like it is. I think you are correct that it could be easier, but I'd like to keep that API stable for now.

Member

evancz commented May 11, 2016

This lives in evancz/elm-graphics now, but I also would prefer to keep the API like it is. I think you are correct that it could be easier, but I'd like to keep that API stable for now.

@evancz evancz closed this May 11, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment