Skip to content
This repository was archived by the owner on Apr 18, 2022. It is now read-only.

Add doctests to Transform, reorder set_rotation_euler arguments.#1052

Merged
bors[bot] merged 1 commit intoamethyst:masterfrom
topokel:master
Nov 25, 2018
Merged

Add doctests to Transform, reorder set_rotation_euler arguments.#1052
bors[bot] merged 1 commit intoamethyst:masterfrom
topokel:master

Conversation

@topokel
Copy link
Copy Markdown
Member

@topokel topokel commented Oct 19, 2018

No description provided.

Copy link
Copy Markdown
Member

@torkleyy torkleyy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs ❤️

Thank you!

@torkleyy torkleyy added type: improvement An improvement or change to an existing feature. team: documentation status: ready labels Oct 19, 2018
Copy link
Copy Markdown
Contributor

@AnneKitsune AnneKitsune left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is always so confusing to me, I'm probably wrong

/// Vector3::new(0.0, 1.0, 0.0),
/// None);
/// assert_eq!(t.rotation, rotation);
/// assert_ulps_eq!(t.rotation, Quaternion::from(
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't that down?

/// assert_eq!(t.rotation, Quaternion::one());
/// // look up with up pointing backwards
/// t.look_at(Point3::new(0.0, 1.0, 0.0), Vector3::new(0.0, 0.0, 1.0));
/// t.look_at(Point3::new(0.0, 1.0, 0.0), Vector3::new(1.0, 0.0, 0.0));
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have the feeling the first one my more sense in respect to the comment saying up is z+

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's best we wait just a little to merge this since Ellie is so far along with nalgebra.. I'd really like to make visualizations for these things to help me and others but mostly me

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because I feel as confused as you do here. I developed this current solution (as if this is a puzzle lol) with @Rhuagh

Copy link
Copy Markdown
Member

@LucioFranco LucioFranco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome thanks

@torkleyy
Copy link
Copy Markdown
Member

The nalgebra PR has been merged, do you think these examples can be rebased onto that?

@topokel
Copy link
Copy Markdown
Member Author

topokel commented Nov 11, 2018

I'll be rebasing these tonight.

@torkleyy
Copy link
Copy Markdown
Member

Postponing until after 0.10.

@topokel
Copy link
Copy Markdown
Member Author

topokel commented Nov 23, 2018

Sorry for the delay 😭 rebased!

@topokel topokel changed the title Add doctests to Transform::from(), ::set_rotation(), and fix ::look_at() doctest Add doctests to Transform, reorder set_rotation_euler arguments. Nov 23, 2018
@topokel
Copy link
Copy Markdown
Member Author

topokel commented Nov 23, 2018

Reordered the set_rotation_euler arguments to match nalgebra, documented in changelog. This should be ready to merge now.

@dotellie
Copy link
Copy Markdown

I think that change might have broken some of the examples so you should probably have a look through those or maybe just do a global search for the function.

@topokel
Copy link
Copy Markdown
Member Author

topokel commented Nov 23, 2018

Ran tests, did a search and didn't find any usages except the ones I touched. We should be good afaict.

Copy link
Copy Markdown
Member

@torkleyy torkleyy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it, thanks!
Can we get this merged soon?

@torkleyy torkleyy requested a review from dotellie November 25, 2018 14:53
Copy link
Copy Markdown

@dotellie dotellie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! If you just remove the newline, rebase and (maybe) squash this should be good to merge! 😄

@topokel
Copy link
Copy Markdown
Member Author

topokel commented Nov 25, 2018

Good catch. Rebased.

Copy link
Copy Markdown

@dotellie dotellie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome thanks!
bors r+

@bors
Copy link
Copy Markdown
Contributor

bors bot commented Nov 25, 2018

👎 Rejected by label

@dotellie
Copy link
Copy Markdown

Oh wait, @torkleyy do you still want to wait?

Copy link
Copy Markdown
Member

@torkleyy torkleyy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR was updated and release moved anyway, so let's merge this. Thanks for making sure though!

bors r=magnonellie,LucioFranco,torkleyy

bors bot added a commit that referenced this pull request Nov 25, 2018
1052: Add doctests to Transform, reorder set_rotation_euler arguments. r=magnonellie,LucioFranco,torkleyy a=distransient



Co-authored-by: kel <distransient@protonmail.com>
@bors
Copy link
Copy Markdown
Contributor

bors bot commented Nov 25, 2018

Build succeeded

@bors bors bot merged commit f3bd6c1 into amethyst:master Nov 25, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

team: documentation type: improvement An improvement or change to an existing feature.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants