Skip to content
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

Name behavior is changing between 5.3 and 5.4 #2968

Closed
freenerd opened this issue Sep 29, 2016 · 1 comment
Closed

Name behavior is changing between 5.3 and 5.4 #2968

freenerd opened this issue Sep 29, 2016 · 1 comment

Comments

@freenerd
Copy link
Member

With the introduction of the name/ref split #2704 we introduced a backwards incompatibility in the step objects:

// 5.3
{
  "name": "Street Name (Street Reference)"
}

// 5.4
{
  "name": "Street Name",
  "ref": "Street Reference"
}

This change was motivated by a better new name detection #2900 and to give clients better control over how text instructions are compiled and reference shields are displayed. In some cases, clients did regex parsing of the name to extract the ref. This was undocumented behaviour and we are okay with breaking that. Unfortunately, there are also cases where the ref is actually crucial information for guidance:

// 5.3
{
  "name": "I-80"
}

// 5.4
{
  "name": "",
  "ref": "I-80"
}

This case we shall not break, since clients relying only on name will now miss information.

Let's find a backwards compatible implementation that retains the old design, but allows clients to also switch to the name/ref split now already. By Version v6 we should make the name/ref split mandatory.

@freenerd
Copy link
Member Author

In discussion, @MoKob @willwhite and me came to the conclusion that this is not actually a breaking change, since in the profiles developers can still decide to retain the old behaviour by using the old name/ref code. This will not enable the new funky new name detection, but retains API compatibility for everyone who is looking for it.

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

No branches or pull requests

1 participant