Skip to content

Commit

Permalink
updated c++ func doc
Browse files Browse the repository at this point in the history
  • Loading branch information
DrewScatterday committed Nov 23, 2024
1 parent 42d7366 commit 3b1f0e7
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions spatial/src/spatial/core/functions/scalar/st_geometrytype.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,14 @@ static void WKBTypeFunction(DataChunk &args, ExpressionState &state, Vector &res
// Documentation
//------------------------------------------------------------------------------
static constexpr const char *DOC_DESCRIPTION = R"(
Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type.
Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type. Possible enum return types are: `POINT`, `LINESTRING`, `POLYGON`, `MULTIPOINT`, `MULTILINESTRING`, `MULTIPOLYGON`, and `GEOMETRYCOLLECTION`.
)";

static constexpr const char *DOC_EXAMPLE = R"()";
static constexpr const char *DOC_EXAMPLE = R"(
SELECT DISTINCT ST_GeometryType(ST_GeomFromText('POINT(1 1)'));
----
POINT
)";

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

0 comments on commit 3b1f0e7

Please sign in to comment.