search

camaraproject / DeviceLocation

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

Doc: Embed documentation into API spec #71

Closed jlurien closed 1 year ago

jlurien commented 1 year ago

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Comply with Commonalities guidelines.

Special notes for reviewers:

Review that wording is correct. Suggest clarifications or improvements

Changelog input

API doc is now embedded into API spec

Additional documentation

jlurien commented 1 year ago

May I ask 2 questions:

  • Do we not intend to define how the match rate should be calculated? Our definition seems open to interpretation to the implementer.
  • Why is the match partial if the network can provide "higher" accuracy ? Do you mean the numerical value in the response is larger ? This is actually "worse" accuracy than requested. This may be misunderstood. Thank you.

We should try to agree on a common understanding and implementation. Indeed, there is an open discussion on how to approach the situation with worse accuracy by the network (higher value here is really the opposite). We may open a dedicate discussion for implementation guidelines, and for the time being I'll rephrase the current description to make it more neutral.