search

google / open-location-code

Open Location Code is a library to generate short codes, called "plus codes", that can be used as digital addresses where street addresses don't exist.
https://plus.codes
Apache License 2.0
4.1k stars 474 forks source link

Documentation conflicts on whether 8 characters may be removed in shortening #462

Closed fulldecent closed 2 years ago

fulldecent commented 3 years ago

In the shorten method documentation / https://github.com/google/open-location-code/blob/a323e80159d6d6170158cc22497250cb86bf3583/API.txt

Passed a valid full Open Location Code and a latitude and longitude this removes as many digits as possible (up to a maximum of eight) ...

In the Plus Codes specification https://github.com/google/open-location-code/blob/main/docs/specification.md#short-codes

Short codes have at least two and a maximum of six digits removed from the beginning of the code

fulldecent commented 3 years ago

This is fixed in https://github.com/google/open-location-code/pull/463

Preference is given to "Short codes have at least two and a maximum of six digits removed from the beginning of the code" and all other conflicting notes are obliterated.