turf icon indicating copy to clipboard operation
turf copied to clipboard

Proposal: Module renaming for v7

Open rowanwins opened this issue 4 years ago • 2 comments

If we're working towards a release of v7 then now would be a good time to rename any modules as a breaking change.

  • [ ] lineIntersect to become intersectionPoints. Rationale being is that this module supports both polygons and lines, and I think the proposed name is a bit clearer as to what it does and returns.

Any other thoughts for candidates @mfedderly @JamesLMilner @twelch ?

rowanwins avatar Jul 31 '21 04:07 rowanwins

I agree that lineIntersect is a bit confusing considering it works on LineStrings and Polygons. I would be happy to rename it to intersectionPoints if that helps provide clarity to users

JamesLMilner avatar Jul 31 '21 09:07 JamesLMilner

I don't know of any other renames offhand, but I made a PR for lineIntersect https://github.com/Turfjs/turf/pull/2187

mfedderly avatar Aug 04 '21 18:08 mfedderly