[
https://issues.apache.org/jira/browse/TINKERPOP-2558?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18146870#comment-18146870
]
ASF GitHub Bot commented on TINKERPOP-2558:
-------------------------------------------
spmallette commented on code in PR #3809:
URL: https://github.com/apache/tinkerpop/pull/3809#discussion_r4617814547
##########
docs/src/reference/the-traversal.asciidoc:
##########
@@ -6644,6 +6647,35 @@ g.V().has('person', 'name', regex('r')).values('name')
g.V().has('person', 'name', regex('r$')).values('name')
----
+The geometry predicates match a value only against a `Geometry` in the same
spatial reference system, and a value they
+cannot compare does not match rather than raising an error. `geoWithin` and
`geoContains` exclude the boundary, so a
+point lying only on a polygon's edge is not within that polygon.
`geoWithinDistance` is inclusive and measures in
+coordinate units for a `CARTESIAN` geometry and in meters for a `GEOGRAPHIC`
one. All geometry math is two
+dimensional, so z is ignored. The
+link:https://tinkerpop.apache.org/docs/x.y.z/dev/provider/#gremlin-semantics-geometry[Geometry
Section] of the Gremlin
+Semantics specification defines these rules in full.
+
+The predicates may be written with or without the `GeoP` prefix, so
`GeoP.geoWithin(g)` and `geoWithin(g)` are the
+same predicate. A geometry is written with the `Geometry()` literal, which
takes Well-Known Text and an optional
+coordinate model or SRID and is described in
<<canonical-gremlin-literal-types,Canonical Gremlin Literal Types>>. In
+Java the predicates are static methods of `GeoP`, and `Geometry.fromWkt()` and
`Point.of()` create the same values.
+
+[source,text]
Review Comment:
any reason this is a `text` example and not a running example?
> GEO Spatial APIs
> ----------------
>
> Key: TINKERPOP-2558
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2558
> Project: TinkerPop
> Issue Type: Improvement
> Components: process
> Affects Versions: 3.5.0
> Reporter: Jitesh
> Priority: Major
>
> Provide support for Geo based APIs (predicates, objects, etc)
>
>
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)