You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
The text was updated successfully, but these errors were encountered:
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.
With the introduction of the name/ref split #2704 we introduced a backwards incompatibility in the step objects:
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 theref
. 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: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 thename
/ref
split mandatory.The text was updated successfully, but these errors were encountered: