Mark old nearest-point-on-line properties as deprecated#3005
Merged
mfedderly merged 3 commits intoTurfjs:masterfrom Mar 12, 2026
Merged
Conversation
Modify generate-readmes script to exclude deprecated tags
Affects lineOverlap, lineSlice, lineSplit and pointToLineDistance
Contributor
Author
|
This PR has been sitting here for quite a while. @mfedderly You are the one who suggested to mark the old properties as deprecated sooner rather than later in #2867 (comment). Could you please take a look at this solution? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is a follow-up to #2867. I have found a way to properly mark the old nearestPointOnLine properties as deprecated without messing up the generated Readme docs. I modified the generate-readmes script slightly to make it work.
The result is what can be seen in #2867 (comment)
I also used this opportunity to switch the lineOverlap, lineSlice, lineSplit and pointToLineDistance functions over to the new properties. It would be a bit embarrassing if turf's own functions would continue to use properties marked as deprecated. 😉
Please provide the following when creating a PR:
contributorsfield ofpackage.json- you've earned it! 👏