mapbox-gl-js icon indicating copy to clipboard operation
mapbox-gl-js copied to clipboard

Updated comment for LngLatBounds to discuss the range of valid input for this method in order to reflect in the API docs on site

Open emilygamedeveloper opened this issue 3 months ago • 1 comments

In parallel with a customer request about fitbounds, I've added a description to the LngLatBounds API comment to specify the limitations of the longitude and latitude ranges so it can be reflected in the site's API documentation.

This has been edited in both lng_lat.js and lng_lat_bounds.js since the original comment appeared in both locations, however from tests it only seems the comment in lng_lat.js actually made a change to the generated API docs.

LngLatBounds

Launch Checklist

  • [X] Make sure the PR title is descriptive and preferably reflects the change from the user's perspective.
  • [X] Add additional detail and context in the PR description (with screenshots/videos if there are visual changes).
  • [X] Manually test the debug page.
  • [N/A] Write tests for all new functionality and make sure the CI checks pass.
  • [X] Document any changes to public APIs.
  • [N/A] Post benchmark scores if the change could affect performance.
  • [N/A] Tag @mapbox/map-design-team @mapbox/static-apis if this PR includes style spec API or visual changes.
  • [N/A] Tag @mapbox/gl-native if this PR includes shader changes or needs a native port.

emilygamedeveloper avatar Apr 04 '24 17:04 emilygamedeveloper