Skip to content

Commit

Permalink
Clarify toBounds docstring (#9032)
Browse files Browse the repository at this point in the history
Clarify that toBounds returns LngLatBounds completely containing given radius
  • Loading branch information
adrianababakanian authored Nov 28, 2019
1 parent 8e8a280 commit 009fecf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/geo/lng_lat.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class LngLat {
}

/**
* Returns a `LngLatBounds` from the coordinates extended by a given `radius`.
* Returns a `LngLatBounds` from the coordinates extended by a given `radius`. The returned `LngLatBounds` completely contains the `radius`.
*
* @param {number} [radius=0] Distance in meters from the coordinates to extend the bounds.
* @returns {LngLatBounds} A new `LngLatBounds` object representing the coordinates extended by the `radius`.
Expand Down

0 comments on commit 009fecf

Please sign in to comment.