heremaps / flexible-polyline

Flexible Polyline encoding: a lossy compressed representation of a list of coordinate pairs or triples
MIT License
91 stars 77 forks source link

Request to update the README.md of this Python section #65

Closed kyooryoo closed 4 months ago

kyooryoo commented 1 year ago

I am Ling Jiang, the Platform Support Engineer in HERE. This feedback is from the support case CS0092990. The customer got confused as they cannot get the same encoded value from example: https://developer.here.com/documentation/traffic-api/dev_guide/topics/concepts/geospatial-filters.html Please update the README.md section by adding the precision=6 or at least remind it. As mentioned in the official document https://pypi.org/project/flexpolyline/

For your reference:

print(fp.encode(example)) # this might be what the customer got by default. BF81zgKsl1xCoUs7DojBrU0RgxC3N--C

print(fp.encode(example, precision=6)) # this is what we provided in our example. BG-6kmkDw1zwZqqG6xmBsgL5rGmwFgqZ_oEw1d

VeaaC commented 1 year ago

I would think that that should be documented in the traffic-api service you linked, not the in (generic) library that supports every possible precision?

VeaaC commented 4 months ago

Closing, as I mentioned this should be documented in the service that is using this format to expose same data.