[GH-2678] Add SVG illustrations for predicate functions#2681
Merged
[GH-2678] Add SVG illustrations for predicate functions#2681
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds visual SVG illustrations (TRUE/FALSE cases) for spatial predicate functions and embeds them into the SQL, Flink, and Snowflake predicate documentation pages to improve clarity for readers (Phase 1 of #2678).
Changes:
- Added 26 new SVG diagrams under
docs/image/ST_<Predicate>/(true/false per predicate). - Embedded those images into 39 predicate docs across SQL, Flink, and Snowflake documentation variants.
Reviewed changes
Copilot reviewed 39 out of 65 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/image/ST_Within/ST_Within_true.svg | New TRUE-case illustration for ST_Within. |
| docs/image/ST_Within/ST_Within_false.svg | New FALSE-case illustration for ST_Within. |
| docs/image/ST_Touches/ST_Touches_true.svg | New TRUE-case illustration for ST_Touches. |
| docs/image/ST_Touches/ST_Touches_false.svg | New FALSE-case illustration for ST_Touches. |
| docs/image/ST_Relate/ST_Relate_true.svg | New TRUE-case illustration for ST_Relate (pattern overload). |
| docs/image/ST_Relate/ST_Relate_false.svg | New FALSE-case illustration for ST_Relate (pattern overload). |
| docs/image/ST_Overlaps/ST_Overlaps_true.svg | New TRUE-case illustration for ST_Overlaps. |
| docs/image/ST_Overlaps/ST_Overlaps_false.svg | New FALSE-case illustration for ST_Overlaps. |
| docs/image/ST_OrderingEquals/ST_OrderingEquals_true.svg | New TRUE-case illustration for ST_OrderingEquals. |
| docs/image/ST_OrderingEquals/ST_OrderingEquals_false.svg | New FALSE-case illustration for ST_OrderingEquals. |
| docs/image/ST_Intersects/ST_Intersects_true.svg | New TRUE-case illustration for ST_Intersects. |
| docs/image/ST_Intersects/ST_Intersects_false.svg | New FALSE-case illustration for ST_Intersects. |
| docs/image/ST_Equals/ST_Equals_true.svg | New TRUE-case illustration for ST_Equals. |
| docs/image/ST_Equals/ST_Equals_false.svg | New FALSE-case illustration for ST_Equals. |
| docs/image/ST_Disjoint/ST_Disjoint_true.svg | New TRUE-case illustration for ST_Disjoint. |
| docs/image/ST_Disjoint/ST_Disjoint_false.svg | New FALSE-case illustration for ST_Disjoint. |
| docs/image/ST_DWithin/ST_DWithin_true.svg | New TRUE-case illustration for ST_DWithin. |
| docs/image/ST_DWithin/ST_DWithin_false.svg | New FALSE-case illustration for ST_DWithin. |
| docs/image/ST_Crosses/ST_Crosses_true.svg | New TRUE-case illustration for ST_Crosses. |
| docs/image/ST_Crosses/ST_Crosses_false.svg | New FALSE-case illustration for ST_Crosses. |
| docs/image/ST_Covers/ST_Covers_true.svg | New TRUE-case illustration for ST_Covers. |
| docs/image/ST_Covers/ST_Covers_false.svg | New FALSE-case illustration for ST_Covers. |
| docs/image/ST_CoveredBy/ST_CoveredBy_true.svg | New TRUE-case illustration for ST_CoveredBy. |
| docs/image/ST_CoveredBy/ST_CoveredBy_false.svg | New FALSE-case illustration for ST_CoveredBy. |
| docs/image/ST_Contains/ST_Contains_true.svg | New TRUE-case illustration for ST_Contains. |
| docs/image/ST_Contains/ST_Contains_false.svg | New FALSE-case illustration for ST_Contains. |
| docs/api/sql/Predicates/ST_Within.md | Embedded ST_Within TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Touches.md | Embedded ST_Touches TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Relate.md | Embedded ST_Relate TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Overlaps.md | Embedded ST_Overlaps TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_OrderingEquals.md | Embedded ST_OrderingEquals TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Intersects.md | Embedded ST_Intersects TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Equals.md | Embedded ST_Equals TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Disjoint.md | Embedded ST_Disjoint TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_DWithin.md | Embedded ST_DWithin TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Crosses.md | Embedded ST_Crosses TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Covers.md | Embedded ST_Covers TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_CoveredBy.md | Embedded ST_CoveredBy TRUE/FALSE images (SQL docs). |
| docs/api/sql/Predicates/ST_Contains.md | Embedded ST_Contains TRUE/FALSE images (SQL docs). |
| docs/api/flink/Predicates/ST_Within.md | Embedded ST_Within TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Touches.md | Embedded ST_Touches TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Relate.md | Embedded ST_Relate TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Overlaps.md | Embedded ST_Overlaps TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_OrderingEquals.md | Embedded ST_OrderingEquals TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Intersects.md | Embedded ST_Intersects TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Equals.md | Embedded ST_Equals TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Disjoint.md | Embedded ST_Disjoint TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_DWithin.md | Embedded ST_DWithin TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Crosses.md | Embedded ST_Crosses TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Covers.md | Embedded ST_Covers TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_CoveredBy.md | Embedded ST_CoveredBy TRUE/FALSE images (Flink docs). |
| docs/api/flink/Predicates/ST_Contains.md | Embedded ST_Contains TRUE/FALSE images (Flink docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Within.md | Embedded ST_Within TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Touches.md | Embedded ST_Touches TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Relate.md | Embedded ST_Relate TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Overlaps.md | Embedded ST_Overlaps TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_OrderingEquals.md | Embedded ST_OrderingEquals TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Intersects.md | Embedded ST_Intersects TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Equals.md | Embedded ST_Equals TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Disjoint.md | Embedded ST_Disjoint TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_DWithin.md | Embedded ST_DWithin TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Crosses.md | Embedded ST_Crosses TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Covers.md | Embedded ST_Covers TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_CoveredBy.md | Embedded ST_CoveredBy TRUE/FALSE images (Snowflake docs). |
| docs/api/snowflake/vector-data/Predicates/ST_Contains.md | Embedded ST_Contains TRUE/FALSE images (Snowflake docs). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 39 out of 65 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
Did you read the Contributor Guide?
Is this PR related to a ticket?
[GH-XXX] my subject. Closes Sedona doc should have visuals for individual function to illustrate #2678What changes were proposed in this PR?
Added SVG visual illustrations for 13 spatial predicate functions, showing both TRUE and FALSE cases for each:
ST_Contains, ST_CoveredBy, ST_Covers, ST_Crosses, ST_Disjoint, ST_DWithin, ST_Equals, ST_Intersects, ST_OrderingEquals, ST_Overlaps, ST_Relate, ST_Touches, ST_Within
Each predicate gets two SVG diagrams (true/false case) stored in docs/image/ST_Name/. The diagrams use blue for Geometry A and red for Geometry B with clear labeling.
The same images are referenced from all three doc variants:
ST_RelateMatch was skipped as it does not operate on geometries directly.
This is Phase 1 (Predicates) of the documentation visuals effort described in #2678.
How was this patch tested?
Did this PR include necessary documentation updates?