warn about U+2028 and U+2029

Open
#12 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Locate the specification section covering grid strings and JSONP, then read the surrounding guidance before making the documentation change. Document the U+2028 and U+2029 limitation and recommend avoiding them or encoding them as \u2028 and \u2029; done means the spec clearly states both recommendations.

Written by the indexing model from the issue text.

Description

The codepoints U+2028 and U+2029 are not valid in JavaScript string literals, and any utfgrid JSON that contains them literally will not be usable with JSONP. We should note this in the spec and recommend avoiding them or encoding them as \u2028 and \u2029 wherever they appear in the grid strings.

Dominant language
No language data
Stars
153
Forks
26
PR merge metrics
No merged PRs in 30d

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.

More from mapbox/utfgrid-spec

All issues in mapbox/utfgrid-spec

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.