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.06k stars 472 forks source link

CPP implementation: does not reference a required separator character #443

Open fulldecent opened 3 years ago

fulldecent commented 3 years ago

The C++ implementation states:

// Returns an Open Location Code with code_length significant digits. The string // returned may be one character longer if it includes a separator character // for formatting.

This is underspecified. Every plus code will have a separator character. CITATION NEEDED. Therefore a better wording would be to say:

// Returns an Open Location Code with code_length significant digits. The string // returned will be one character longer because it includes a separator character // for formatting.

fulldecent commented 3 years ago

Recommended tag: implementation

fulldecent commented 3 months ago

I realize this wording is CPP is based on a older and outdated understanding of OLC that used to be here. So this is issue should still be fixed.