mapbox / mapbox/mapbox-sdk-js

reword fresh=true guidance

Open Beginner friendly
#417 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
768
Forks
191
PR merge metrics
No merged PRs in 30d

Description

The documentation currently says "fresh=true should never be used in production or high concurrency environments." however that's not quite true, as it depends on the application.

An application which fetches a style to mutate it, then write it back to the account, might be used in "production" and should use fresh=true to ensure it always operates on the latest non-cached style.

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

Search the documentation for the quoted fresh=true guidance and read the surrounding section. Reword the statement so its use is presented as application-dependent, including the documented style-fetch, mutation, and write-back scenario; confirm the rendered documentation reflects the revised wording.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.