mapbox / mapbox/mapbox-gl-js

Better documentation for global transition option

Open
#6,689 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Documentation for the [global `transition` property](https://www.mapbox.com/mapbox-gl-js/style-spec#root-transition) (as well as the [general `transition` type](https://www.mapbox.com/mapbox-gl-js/style-spec#transition)) is pretty thin and could be clarified.

Related: https://github.com/mapbox/mapbox-gl-js/issues/4081.

Ref: https://github.com/mapbox/mapbox-gl-js/issues/6519 (closed in favor of this ticket).

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.

Research direction

Start by reading the linked global `transition` property and general `transition` type references, then review the related issues 4081 and 6519 for context. Done means both documentation sections clearly explain the option and its behavior without leaving the current scope ambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.