Updates Documentation from Strings to Units#2838
Conversation
|
Thanks for putting this together @conor-f. Could I please ask a favour? Rather than link to the md file in the repo, it's probably cleaner to point people to the website instead. Would you have an easy way to update the PR to do that? If it means hand editing them all again, maybe we can put our heads together to automate it somehow. There is a separate pages for linear and areas units as well: And then ultimately we'll retire https://github.com/Turfjs/turf/blob/master/packages/turf-helpers/README_UNITS.md |
|
Thanks for getting back to me @smallsaucepan :) Updated the PR to link to the website version of the docs as requested. All of these changes were related to Let me know if there's any other issues :) |
|
Thanks @conor-f. That's fantastic. Appreciate you taking care of this! |
In many places the documentation suggested that the only types a method could take were strings like
milesorkilometerswhen the code actually supported allUnits. Updated this in any place I could find usinggrepto find the files that needed changes, and manually updating the comments.This is a non-breaking change.
Supercedes #2218 but fixes no open issues.
Please provide the following when creating a PR:
contributorsfield ofpackage.json- you've earned it! 👏