-
Notifications
You must be signed in to change notification settings - Fork 79
Rename Components of The Routable Protocol #107
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
Rename Components of The Routable Protocol #107
Conversation
hlineholm
commented
Oct 14, 2018
- Remove use of segment as it actually refers to route element
- Shorten names in order to increase readability without loosing unambiguity
Codecov Report
@@ Coverage Diff @@
## master #107 +/- ##
=======================================
Coverage 85.57% 85.57%
=======================================
Files 5 5
Lines 201 201
=======================================
Hits 172 172
Misses 29 29
Continue to review full report at Codecov.
|
|
Should be squashed... |
|
@hlineholm When making breaking changes like this (renaming, changing, or removing public members), we should try to build a habit of adding the new stuff, and then marking the old ones as deprecated (& pointing to the new items) One can deprecate the old items here like this: @available(*, deprecated, message: "Deprecated in favor of `RouteElement`") public typealias RouteElementIdentifier = RouteElementThis way we can push out a minor update and allow users to migrate before a major release with breaking changes. |
|
I'll add it! |
|
@hlineholm-flir Do you want to update this to the current master so we can merge this in? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add deprecation notices for the renaming (as @mjarvis noted in #107 (comment)) can be skipped since we have breaking changes anyway
|
@hlineholm We've merged #116 with a similar intent, so this would be a great addition in the same vein. You could even skip the deprecation notices since there's breaking changes scheduled for v0.7 anyway. Could you rebase your branch or merge master into it? |
|
@hlineholm / @hlineholm-flir Are you still interested in updating the PR? |
|
Yes @DivineDominion I am. Haven't had time to work on this lately so might be good if someone takes a look at the changes to see that I'm not missing anything. I've rebased it on latest master and in that process I discovered I'd missed some renaming in a test and in the README.md. |
|
Thanks! Looks good to me. I'll request another pair of eyes :) |
|
Looks good! |