Skip to content

Restore JSDoc change to the Camera section of Map Instance Members#13621

Closed
chriswhong wants to merge 1 commit intomainfrom
cw/fix-camera-docs
Closed

Restore JSDoc change to the Camera section of Map Instance Members#13621
chriswhong wants to merge 1 commit intomainfrom
cw/fix-camera-docs

Conversation

@chriswhong
Copy link
Contributor

This PR reverts a JSDoc change made in #13439 that caused a rendering issue with the API reference documentation on docs.mapbox.com.

The change caused documentation.js to omit the sub-section Camera under instance members, causing all of the camera members (flyTo(), getZoom(), etc) to be listed under the preceding section Debug features.

Restoring the JSDoc comment causes documentation.js to properly add the Camera section to its output, and the docs site will render it correctly.

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.
  • Write tests for all new functionality and make sure the CI checks pass.
  • Document any changes to public APIs.
  • Post benchmark scores if the change could affect performance.
  • Tag @mapbox/map-design-team @mapbox/static-apis if this PR includes style spec API or visual changes.
  • Tag @mapbox/gl-native if this PR includes shader changes or needs a native port.
  • Tag @mapbox/gl-native if this PR disables any test because it also needs to be disabled on their side.
  • Create a ticket for gl-native to groom in the MAPSNAT JIRA queue if this PR includes shader changes or features not present in the native side or if it disables a test that's not disabled there.

@chriswhong chriswhong requested a review from a team as a code owner February 4, 2026 15:16
@github-actions
Copy link

github-actions bot commented Feb 4, 2026

Hey, @chriswhong 👋 Thanks for your contribution to Mapbox GL JS!

Important: This repository does not accept direct merges. All changes go through our internal review process.

What happens next:

  1. A team member will review your PR here first
  2. If it looks good, they will import it to our internal repository for further review
  3. If approved, changes will be synced back here via our release process

Please respond to any review comments on this PR. For more details, see CONTRIBUTING.md.

@mourner mourner closed this Feb 4, 2026
@mourner
Copy link
Member

mourner commented Feb 4, 2026

Please submit the PR in the internal repo to get this merged 🙏

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.

2 participants