nit(rename): Renames the encoded live speed properties #2998
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to make it clear that the raw values are usually not what you want. They are not measured in kph, but have on several occasions been used in that way due to the non-obvious naming. This rename adds `encoded_` to the speed properties to make it clearer that the value within may not be what you actually want. There already are getter-functions defined which should be preferred in most use-cases
purew
force-pushed
the
nit-rename-live-speed-property
branch
from
5a42928
to
818db24
Compare
danpat
reviewed
Apr 13, 2021
valhalla/baldr/traffictile.h
Outdated
| } | ||
|
|
||
| json::MapPtr json() const volatile { | ||
| auto live_speed = json::map({}); | ||
| if (speed_valid()) { | ||
| live_speed->emplace("overall_speed", static_cast<uint64_t>(get_overall_speed())); | ||
| live_speed->emplace("overall_encoded_speed", static_cast<uint64_t>(get_overall_speed())); |
There was a problem hiding this comment.
This one isn't encoded, it's accessed via the getter
There was a problem hiding this comment.
its also a breaking change to the locate API so we probably shouldnt change it
|
@purew was the pybind update on purpose? |
Nope! Mistake, one sec. |
|
@kevinkreiser @danpat any last thoughts on this? |
|
@purew just needs a changelog entry :-) |
danpat
approved these changes
Apr 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
to make it clear that the raw values are usually not what you want.
They are not measured in kph, but have on several occasions been
used in that way due to the non-obvious naming.
This rename adds
encoded_to the speed properties to make itclearer that the value within may not be what you actually want.
There already are getter-functions defined which should be preferred
in most use-cases