Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fulldecent opened this issue Jun 3, 2021 · 1 comment

Comments

@fulldecent
Copy link
Contributor

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 fulldecent mentioned this issue Jun 4, 2021
9 tasks
@fulldecent
Copy link
Contributor Author

This is fixed in #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.

bocops added a commit to bocops/open-location-code that referenced this issue Jan 28, 2022
As has been noted in google#462, there's a discrepancy between this file and the OLC specification regarding the number of digits that can be removed while shortening. This PR resolves this conflict in a minimally invasive way by referencing the specification instead of claiming a different value.

This resolves the aforementioned google#462, which can then be closed. Please check if version number needs a patch-level bump due to this change.
bocops added a commit to bocops/open-location-code that referenced this issue Jan 28, 2022
As has been noted in google#462, there's a discrepancy between this file and the OLC specification regarding the number of digits that can be removed while shortening. This PR resolves this conflict in a minimally invasive way by referencing the specification instead of claiming a different value.

This resolves the aforementioned google#462, which can then be closed. Please check if version number needs a patch-level bump due to this change.
@phebehp phebehp closed this as completed Jun 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants