Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 2 commits into from

Conversation

emilygamedeveloper
Copy link
Contributor

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

  • Make sure the PR title is descriptive and preferably reflects the change from the user's perspective.
  • Add additional detail and context in the PR description (with screenshots/videos if there are visual changes).
  • Manually test the debug page.
  • [N/A] Write tests for all new functionality and make sure the CI checks pass.
  • 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.

This has been edited in both lng_lat.js and lng_lat_bounds.js but from tests it only seems lng_lat.js is needed but cross posting for consistency just in case.
@emilygamedeveloper emilygamedeveloper requested a review from a team as a code owner April 4, 2024 17:49
@emilygamedeveloper
Copy link
Contributor Author

@stepankuzmin Hey Stepan! When you have time would you be able to review this PR? Absolutely no rush!

Also I'm getting a failure in the CircleCi test unit, but it's not related to my changes.

Thanks for your time!

@emilygamedeveloper emilygamedeveloper deleted the lnglatbounds-specify-parameter-range branch May 14, 2024 19:42
@emilygamedeveloper
Copy link
Contributor Author

Moved this change to the internal version of the repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant