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

Several symbols are incorrectly renamed #2289

Closed
1ec5 opened this issue Dec 20, 2019 · 0 comments · Fixed by #2297
Closed

Several symbols are incorrectly renamed #2289

1ec5 opened this issue Dec 20, 2019 · 0 comments · Fixed by #2297
Labels
bug Something isn’t working op-ex Refactoring, Tech Debt or any other operational excellence work. release blocker Needs to be resolved before the release.
Milestone

Comments

@1ec5
Copy link
Contributor

1ec5 commented Dec 20, 2019

Several availability attributes specify misleading renamed: arguments that result in broken code. For example, take this code targeting v0.38:

play(soundForInstruction)

After #2230, this code produces the following deprecation warning and fix-it suggestion:

/path/to/navigation-ios-examples/Navigation-Examples/Examples/Custom-Voice-Controller.swift:54:9: 'play' is deprecated: replaced by 'MapboxVoiceController.play(instruction:data:)'
/path/to/navigation-ios-examples/Navigation-Examples/Examples/Custom-Voice-Controller.swift:54:9: Use 'MapboxVoiceController.play(instruction:data:)' instead

which turns it into the nonsensical:

MapboxVoiceController.play(soundForInstruction)

which results in this error:

/path/to/navigation-ios-examples/Navigation-Examples/Examples/Custom-Voice-Controller.swift:54:35: 'Data' is not convertible to 'MapboxVoiceController'

renamed: is only a little more sophisticated than a straight-up find-and-replace in that it splits the replacement string by colons. Anything requiring a more complex edit needs to go in a message:. The following renamed: arguments are misleading and need to be replaced by message::

/cc @mapbox/navigation-ios

@1ec5 1ec5 added bug Something isn’t working op-ex Refactoring, Tech Debt or any other operational excellence work. release blocker Needs to be resolved before the release. labels Dec 20, 2019
@1ec5 1ec5 added this to the v1.0.0 milestone Dec 20, 2019
@JThramer JThramer self-assigned this Jan 3, 2020
@1ec5 1ec5 modified the milestones: v1.0.0, v0.x next Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn’t working op-ex Refactoring, Tech Debt or any other operational excellence work. release blocker Needs to be resolved before the release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants