Documentation: Supporting "meters" unit

[ozomer]

Hi,
All operations that accepts units of "degrees, radians, miles, or kilometers" can also accept "meters".
One of our developers called distance with unit "kilometers" and divided the result by 1000, because the documentation did not specify that it supports meters too.

Minor issue, not critical...

[rowanwins]

Thanks for the report @ozomer , good pickup!

[DenisCarriere]

Meters is included in the source code:

https://github.com/Turfjs/turf/blob/master/packages/turf-helpers/index.mjs#L10-L11
https://github.com/Turfjs/turf/blob/master/packages/turf-helpers/index.d.ts#L20

I agreed that we could add "meters" in the docs, however we shouldn't include every single unit of measurement in the docs (keep it short & simple).

[andrewharvey]

I've always been converting meters to kilometers since I didn't know meters is supported too.

I agreed that we could add "meters" in the docs, however we shouldn't include every single unit of measurement in the docs (keep it short & simple).

I disagree, the documentation should document all supported options.

[mfedderly]

I'd love to have the documentation be accurate everywhere but that involves a bunch of duplication that our docs aren't setup for right now. As a half measure, the typescript types reference the canonical list, so any typescript consumers will now get the full list.

[smallsaucepan]

Would this be a suitable approach? Rather than list all options on every function, add a centralised list and embed a link in the Description field. Publicises that other options are available without cluttering up the API documentation.

The full list:

Would do the same for area related units.

[twelch]

@smallsaucepan I'm open to this approach if you want to give it a try. Holler if you have questions

[smallsaucepan]

The Units typedef now has it's own page on the website: https://turfjs.org/docs/next/api/types/Units As we update documentation for each method they'll begin to link to the full list of options automatically.