Clarify that coordsMap mutates input
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, typescript
- Domain
- documentation
Research direction
Start at the coordEach API description and read how currentCoord and coordIndex are documented, especially for (Multi)Polygon input. Done means the description explicitly explains that modifying currentCoord mutates the input object and clarifies what coordIndex represents.
Written by the indexing model from the issue text.
Description
I was looking for a way to transform each coordinate of a GeoJSON object and was about to propose .coordMap() (similar to #1438).
It was only by reading through the comments that I realised that .coordEach() can be used to do in-place transformation.
I'd suggest updating the description from:
Iterate over coordinates in any GeoJSON object, similar to Array.forEach()
to:
Iterate over coordinates in any GeoJSON object, analogous to Array.forEach(). Modifications to
currentCoordmutate the input object.
(IMHO "analogous" is a better word here than "similar" because of the different arguments and input type)
Also, if possible, clarify what coordIndex is, because it's not that obvious to me in the case of a (Multi)Polygon.
- Dominant language
- TypeScript
- Stars
- 10.5k
- Forks
- 1k
- Avg merge
- 1h 11m
- Merged PRs (30d)
- 4
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.
More from Turfjs/turf
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
@turf/boolean-contains
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
vercel/react-tweet#225 ·