search

camaraproject / DeviceLocation

Repository to describe, develop, document and test the DeviceLocation API family
Apache License 2.0
21 stars 32 forks source link

[location-verification] Precise the description when `matchRate` needs to be set for PARTIAL-results #158

Closed maxl2287 closed 6 months ago

maxl2287 commented 7 months ago

Problem description

If the network's estimation of the device's location partially overlaps with the requested area, or it fully contains the requested area (because it is larger), the result is 'PARTIAL'. In this case, a match_rate may be included in the response, indicating an estimation of the likelihood of the match in percent.

Here it is said that the match_rate "may be" included.

But without this information the PARTIAL-response is not precise.

Expected behavior Change the sentence to:

In this case, a `match_rate` is included in the response, indicating an estimation of the likelihood of the match in percent.