mapbox / mapbox/mapbox-gl-js

"You can use camera expressions anywhere an expression may be used." is incorrect and meaningless.

Open
#12,748 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In the docs, it says:

You can use camera expressions anywhere an expression may be used. When you use a camera expression as the value of a layout or paint property, it must be in one of the following forms:
...
That is, in layout or paint properties, ["zoom"] may appear only as the input to an outer interpolate or step expression, or such an expression within a let expression.

The first sentence basically doesn't mean anything that is true. The second sentence so drastically qualifies it as to make it essentially meaningless. IMHO it should be removed.

It would be more straightforward and correct to remove both the first two sentences and simply write:

In layout or paint properties, ["zoom"] may appear only as the input to an outer interpolate or step expression, or such an expression within a let expression.

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

Locate the documentation section containing the quoted camera expressions text and review the linked interpolate, step, and let references. Remove the two criticized sentences and retain the proposed direct wording about where ["zoom"] may appear; done means the documentation is concise and accurately states the restriction.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.