Skip to content

Commit 28b7234

Browse files
committed
Document that get_bbox() can return nil
1 parent ab84086 commit 28b7234

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

_manual-v2/06-flex-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ The parameter table (`object`) has the following fields and functions:
494494
| .nodes | Ways only: An array with the way node ids. |
495495
| .members | Relations only: An array with member tables. Each member table has the fields `type` (values `n`, `w`, or `r`), `ref` (member id) and `role`. |
496496
| :grab_tag(KEY) | Return the tag value of the specified key and remove the tag from the list of tags. (Example: `local name = object:grab_tag('name')`) This is often used when you want to store some tags in special columns and the rest of the tags in an jsonb or hstore column. |
497-
| :get_bbox() | Get the bounding box of the current node, way, or relation. This function returns four result values: the lon/lat values for the bottom left corner of the bounding box, followed by the lon/lat values of the top right corner. Both lon/lat values are identical in case of nodes. Example: `lon, lat, dummy, dummy = object:get_bbox()`. Relation members (nested relations) are not taken into account. |
497+
| :get_bbox() | Get the bounding box of the current node, way, or relation. This function returns four result values: the lon/lat values for the bottom left corner of the bounding box, followed by the lon/lat values of the top right corner. Both lon/lat values are identical in case of nodes. Example: `lon, lat, dummy, dummy = object:get_bbox()`. Relation members (nested relations) are not taken into account. Returns `nil` if a valid bounding box can not be created for some reason. |
498498
| :as_point() | Create point geometry from OSM node object. |
499499
| :as_linestring() | Create linestring geometry from OSM way object. |
500500
| :as_polygon() | Create polygon geometry from OSM way object. |

0 commit comments

Comments
 (0)