Skip to content

Commit 3b1f0e7

Browse files
updated c++ func doc
1 parent 42d7366 commit 3b1f0e7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

spatial/src/spatial/core/functions/scalar/st_geometrytype.cpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,14 @@ static void WKBTypeFunction(DataChunk &args, ExpressionState &state, Vector &res
8484
// Documentation
8585
//------------------------------------------------------------------------------
8686
static constexpr const char *DOC_DESCRIPTION = R"(
87-
Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type.
87+
Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type. Possible enum return types are: `POINT`, `LINESTRING`, `POLYGON`, `MULTIPOINT`, `MULTILINESTRING`, `MULTIPOLYGON`, and `GEOMETRYCOLLECTION`.
8888
)";
8989

90-
static constexpr const char *DOC_EXAMPLE = R"()";
90+
static constexpr const char *DOC_EXAMPLE = R"(
91+
SELECT DISTINCT ST_GeometryType(ST_GeomFromText('POINT(1 1)'));
92+
----
93+
POINT
94+
)";
9195

9296
static constexpr DocTag DOC_TAGS[] = {{"ext", "spatial"}, {"category", "property"}};
9397
//------------------------------------------------------------------------------

0 commit comments

Comments
 (0)