more legible geo-types debug output (WKT-ish) #1302
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
michaelkirk
force-pushed
the
mkirk/debug-wkt
branch
2 times, most recently
from
429674b to
9688830
Compare
FIXES #564 Note: Most of the output is valid WKT, but not all of it is. For example, there is no RECT or TRIANGLE type in standard WKT. And there are certain invalid representations you can make in geo that are not valid WKT, but for a debug output format we still need to print *something* e.g. a polygon with interiors but no exterior: `POLYGON(EMPTY,(1 2,2 4))`
michaelkirk
force-pushed
the
mkirk/debug-wkt
branch
from
9688830 to
135b570
Compare
michaelkirk
commented
Jan 16, 2025
| #[cfg(feature = "std")] | ||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; |
There was a problem hiding this comment.
The tests are pretty comprehensive, and the best place to see what's what.
michaelkirk
commented
Jan 16, 2025
|
|
||
| let rect = Rect::new((3, 4), (1, 2)); | ||
| // output is always (min, max) | ||
| assert_eq!("RECT(1 2,3 4)", format!("{rect:?}")); |
There was a problem hiding this comment.
Here's an example of output that's not actually WKT, but I think it's still intuitive.
|
I think "don't let the perfect be the enemy of the good" is the right approach here w/r/t/ validity. If it's easy to get 95 % of debug output straight into TestBuilder (etc), and the other 5 % requires some light search and replace, that's still a huge improvement. |
frewsxcv
approved these changes
Jan 22, 2025
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.
CHANGES.mdif knowledge of this change could be valuable to users.FIXES #564
I've wanted this for a long time! Inevitably for any project using geo I end up pulling in some other crate to produce debug output (usually wkt). The writing portion of wkt is pretty short (parsing is a little trickier) which is why I opted to copy the logic rather than relying on the wkt crate or something.
Note: Most of the output is valid WKT, but not all of it is.
For example, there is no RECT or TRIANGLE type in standard WKT.
And there are certain invalid representations you can make in geo that
are not valid WKT, e.g. a polygon with interiors but no exterior. I'm not sure if it's valid WKT, but we need to print something meaningful, in this case:
POLYGON(EMPTY,(1 2,2 4)).