mapbox / mapbox/mapbox-gl-js

Clarify AnimationOptions#offset documentation – move to CameraOptions

Open
#4,240 1 comment 0 reactions 1 assignee View on GitHub

@SnailBones is already working on this.

Since Jul 9, 2021.

docs :scroll:
Dominant language
TypeScript
Stars
12.4k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

We have an existing solution to the top requested feature ( #1740 ) but it's not clear that we do because the docs on this option are confusing.

It is currently in `AnimationOptions` described as:
> x and y coordinates representing the animation's origin of movement relative to the map's center.

I think it should be moved to `CameraOptions` because it affects the Map's positioning after an animation completes, and the documentation should be reworded so it is understandable by regular humans.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.