Document `polygonToCells` limitation of 180 degree width
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 6.5k
- Forks
- 627
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 6
Description
The polyfill/polygonToCells function currently assumes that any polygon with an arc that's > 180 degrees of longitude crosses the antimeridian, leading to problems when users try to fill a world-size bounding box (e.g. a web map viewport). We should document this restriction and possible workarounds (inserting dummy vertices, splitting the polygon).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the API documentation for polyfill and polygonToCells. Document the limitation for polygons wider than 180 degrees of longitude, explain the antimeridian behavior, and include the suggested dummy-vertex and polygon-splitting workarounds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100