Add distance supported units
This commit is contained in:
parent
dcc45070bd
commit
1e3ffa0df7
|
@ -142,9 +142,9 @@ The following are options allowed on the filter:
|
||||||
|=======================================================================
|
|=======================================================================
|
||||||
|Option |Description
|
|Option |Description
|
||||||
|`distance` |The distance to include hits in the filter. The distance
|
|`distance` |The distance to include hits in the filter. The distance
|
||||||
can be a numeric value, and then the `unit` (either `mi`/@miles@ or `km`
|
can be a numeric value, and then the `unit` (either `mi`, `miles`, `in`, `inch`, `yd`, `yards`, `km`, `kilometers`,
|
||||||
can be set) controlling the unit. Or a single string with the unit as
|
`mm`, `millimeters`, `cm`, `centimeters`, `m` or `meters` can be set) controlling the unit.
|
||||||
well.
|
Or a single string with the unit as well.
|
||||||
|
|
||||||
|`distance_type` |How to compute the distance. Can either be `arc`
|
|`distance_type` |How to compute the distance. Can either be `arc`
|
||||||
(better precision) or `plane` (faster). Defaults to `arc`.
|
(better precision) or `plane` (faster). Defaults to `arc`.
|
||||||
|
|
|
@ -169,7 +169,7 @@ itself.
|
||||||
|=======================================================================
|
|=======================================================================
|
||||||
|Option |Description
|
|Option |Description
|
||||||
|`unit` |The unit the ranges are provided in. Defaults to `km`. Can also
|
|`unit` |The unit the ranges are provided in. Defaults to `km`. Can also
|
||||||
be `mi` or `miles`.
|
be `mi`, `miles`, `in`, `inch`, `yd`, `yards`, `kilometers`, `mm`, `millimeters`, `cm`, `centimeters`, `m` or `meters`.
|
||||||
|
|
||||||
|`distance_type` |How to compute the distance. Can either be `arc`
|
|`distance_type` |How to compute the distance. Can either be `arc`
|
||||||
(better precision) or `plane` (faster). Defaults to `arc`.
|
(better precision) or `plane` (faster). Defaults to `arc`.
|
||||||
|
|
Loading…
Reference in New Issue