diff --git a/website/docs/api/vertex.mdx b/website/docs/api/vertex.mdx index 1f1a0e6d5..9efd887ee 100644 --- a/website/docs/api/vertex.mdx +++ b/website/docs/api/vertex.mdx @@ -12,6 +12,9 @@ Vertex mode allows encoding the topological vertexes of H3 cells. ## cellToVertex +Returns the index for the specified cell vertex. Valid vertex numbers are between 0 and 5 (inclusive) +for hexagonal cells, and 0 and 4 (inclusive) for pentagonal cells. + -Returns the index for the specified cell vertex. Valid vertex numbers are between 0 and 5 (inclusive) -for hexagonal cells, and 0 and 4 (inclusive) for pentagonal cells. - ## cellToVertexes +Returns the indexes for all vertexes of the given cell. + @@ -155,13 +161,10 @@ $ h3 cellToVertexes -c 85283473fffffff -Returns the indexes for all vertexes of the given cell index. - -The length of the `out` array must be 6. If the given cell index represents a pentagon, one member of the -array will be set to `0`. - ## vertexToLatLng +Returns the latitude and longitude coordinates of the given vertex. + -Returns the latitude and longitude coordinates of the given vertex. - ## isValidVertex +Determines if the given H3 index represents a valid H3 vertex. + @@ -301,5 +306,3 @@ true - -Returns 1 if the given index represents a valid H3 vertex.