Improve documentation for rewind
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 10.5k
- Forks
- 1k
- Avg merge
- 1h 11m
- Merged PRs (30d)
- 4
Description
The documentation for turf.rewind left me confused after reading it. I could not understand what it was supposed to do.
The description section links to the Shoelace formula on Wikipedia, which itself has no mentions of rewinding or winding. Part of the description should include a short explanation of what winding is and how rewind changes it.
The example section shows the function being called and displays the resulting rectangle, but that rectangle is no different visually than the original rectangle. It would be beneficial to display the JSON or coordinates of both items somehow.
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 with the turf.rewind entry point and its description and example sections. Explain what winding is and how rewind changes it, then make the example expose both the original and rewound JSON or coordinates. It is done when the documentation makes the difference understandable without relying on the Shoelace formula link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100