Document Polygon struct parameters #68
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Addresses georust#60 Replaces the Polygon tuple struct with a regular struct: ``` pub struct Polygon<T> where T: Float { pub exterior: LineString<T>, pub interiors: Vec<LineString<T>> } ``` I'm new to rust and eager to learn so comment away! This breaks the existing Polygon constructor since (correct me if I'm wrong) structs must be instaniated with curly braces and named arguments. To mitigate the effect of this change on existing code, `Polygon` implements a `new` method that preserve the old interface: `Polygon::new(exterior, interiors)` I choose `exterior` and `interiors` over `outer` and `inners` as I believe the former pair is more commonly used. I don't feel strongly about this choice and will change it upon request.
|
As you can see in the little Travis CI section at the bottom, one of the tests failed. You forgot to update one of the examples in the documentation, I think. |
|
Thanks @notriddle! I left out an import, just pushed the fix. |
|
This looks good, but I'm going to leave this open until I/we push a new major version release that includes breaking changes like these. Thanks for doing this @mbattifarano! 🎊 |
|
@aelita-mergebot r+ |
ghost
pushed a commit
that referenced
this pull request
Oct 16, 2016
Merge #68 a=@mbattifarano r=@frewsxcv ________________________________________________________________________ Addresses #60 Replaces the Polygon tuple struct with a regular struct: ``` pub struct Polygon<T> where T: Float { pub exterior: LineString<T>, pub interiors: Vec<LineString<T>> } ``` I'm new to rust and eager to learn so comment away! This breaks the existing Polygon constructor since (correct me if I'm wrong) structs must be instaniated with curly braces and named arguments. To mitigate the effect of this change on existing code, `Polygon` implements a `new` method that preserves the old interface: `Polygon::new(exterior, interiors)` I chose `exterior` and `interiors` over `outer` and `inners` as I believe the former pair is more commonly used. I don't feel strongly about this choice and will change it upon request.
|
No reason to hold this up any longer. Thanks again @mbattifarano! |
|
Looks like there are a few more places the new |
|
@aelita-mergebot r+ |
ghost
pushed a commit
that referenced
this pull request
Oct 16, 2016
Merge #68 a=@mbattifarano r=@frewsxcv ________________________________________________________________________ Addresses #60 Replaces the Polygon tuple struct with a regular struct: ``` pub struct Polygon<T> where T: Float { pub exterior: LineString<T>, pub interiors: Vec<LineString<T>> } ``` I'm new to rust and eager to learn so comment away! This breaks the existing Polygon constructor since (correct me if I'm wrong) structs must be instaniated with curly braces and named arguments. To mitigate the effect of this change on existing code, `Polygon` implements a `new` method that preserves the old interface: `Polygon::new(exterior, interiors)` I chose `exterior` and `interiors` over `outer` and `inners` as I believe the former pair is more commonly used. I don't feel strongly about this choice and will change it upon request.
ghost
merged commit 
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #60
Replaces the Polygon tuple struct with a regular struct:
I'm new to rust and eager to learn so comment away!
This breaks the existing Polygon constructor since (correct me if
I'm wrong) structs must be instaniated with curly braces and named
arguments. To mitigate the effect of this change on existing code,
Polygonimplements anewmethod that preserves the old interface:Polygon::new(exterior, interiors)I chose
exteriorandinteriorsoverouterandinnersas Ibelieve the former pair is more commonly used. I don't feel strongly
about this choice and will change it upon request.