GL JS docs copyedits #11175
Merged
GL JS docs copyedits #11175
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
October 12, 2021 09:28
domlet
added
docs 📜
skip changelog
ryanhamley
suggested changes
Oct 25, 2021
domlet
commented
Oct 26, 2021
src/ui/map.js
Outdated
| * @param {number} [options.zoom=0] The initial zoom level of the map. If `zoom` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`. | ||
| * @param {number} [options.bearing=0] The initial bearing (rotation) of the map, measured in degrees counter-clockwise from north. If `bearing` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`. | ||
| * @param {number} [options.pitch=0] The initial pitch (tilt) of the map, measured in degrees away from the plane of the screen (0-85). If `pitch` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`. | ||
| * @param {LngLatLike} [options.center=[0, 0]] The inital geographical [centerpoint](https://docs.mapbox.com/help/glossary/camera#center) of the map. If `center` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `[0, 0]` Note: Mapbox GL uses longitude, latitude coordinate order (as opposed to latitude, longitude) to match GeoJSON. |
There was a problem hiding this comment.
Great catches @ryanhamley – correcting these issues now. Using #11072 as a reference for OGC:CRS84 and the GeoJSON standard for coordinate order.
Suggested change
| * @param {LngLatLike} [options.center=[0, 0]] The inital geographical [centerpoint](https://docs.mapbox.com/help/glossary/camera#center) of the map. If `center` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `[0, 0]` Note: Mapbox GL uses longitude, latitude coordinate order (as opposed to latitude, longitude) to match GeoJSON. | |
| * @param {LngLatLike} [options.center=[0, 0]] The initial geographical [center](https://docs.mapbox.com/help/glossary/camera#center) point of the map. If `center` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, it will default to `[0, 0]` Note: Mapbox GL uses `longitude, latitude` coordinate order (as opposed to `latitude, longitude`) to match the [GeoJSON specification](https://datatracker.ietf.org/doc/html/rfc7946#section-4), which is equivalent to the OGC:CRS84 coordinate reference system. |
domlet
commented
Oct 26, 2021
domlet
commented
Oct 27, 2021
|
Thanks @ryanhamley for your careful review! I've incorporated your feedback.
The lock file is no longer in the diff for this PR, I ran Any advice on resolving the 1 failing check? |
That's a known issue; the test is just flaky. I'll re-run those tests. |
ryanhamley
approved these changes
Oct 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
YOUR_MAPBOX_ACCESS_TOKENas placeholder string inREADME.mdandCONTRIBUTING.mdper https://github.com/mapbox/documentation/issues/773map.jsoptionssrc/ui/events.jsandsrc/ui/map.jsLaunch Checklist
@mapbox/map-design-team@mapbox/static-apisif this PR includes style spec API or visual changes@mapbox/gl-nativeif this PR includes shader changes or needs a native portmapbox-gl-jschangelog:<changelog></changelog>