-
Notifications
You must be signed in to change notification settings - Fork 197
HARP-13493: Make maxZoomLevel value in technique non inclusive #2016
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2016 +/- ##
==========================================
+ Coverage 66.56% 66.58% +0.01%
==========================================
Files 297 297
Lines 26341 26342 +1
Branches 5944 5945 +1
==========================================
+ Hits 17535 17539 +4
+ Misses 8806 8803 -3
Continue to review full report at Codecov.
|
@@ -693,7 +693,7 @@ export class StyleSetEvaluator { | |||
} | |||
} | |||
|
|||
if (typeof maxZoomLevel === "number" && zoomLevel > maxZoomLevel) { |
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.
We need to document this change in BaseTechniqueParams in @here/harp-datasource-protocol/lib/TechniqueParams.ts.
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.
done
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 document the behaviour change as part of the next release notes:
https://github.com/heremaps/harp.gl/releases/
There's not draft of next release (0.22) so you can create a new one. Just follow the same format as the previous releases. Once done click on "Save draft", not on "Publish release".
I agree with the idea of making it non-inclusive, however the naming is unfortunate, the I think a better name could be start @atomicsulfate , @germanz , please reconsider. |
retest this please |
Signed-off-by: German Zargaryan <german.zargaryan@here.com>
@nzjony I agree with you about the definition of the term. However, I think it is better to keep it simple and document the range It will be unfortunate to break the compatibility by renaming the property or introducing another one and cause confusion. Other Map rendering APIs also use the same terms. |
@@ -264,7 +264,7 @@ export interface BaseTechniqueParams { | |||
minZoomLevel?: DynamicProperty<number>; | |||
|
|||
/** | |||
* Maximum zoom level. If the current zoom level is larger, the technique will not be used. | |||
* Maximum zoom level. If the current zoom level is equal to or greater, the technique will not be used. |
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.
You may want to check with our Design team before going forward with this change of semantics.
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.
Also, shouldn't you update the semantics of all the zoom/data level constraints? e.g. DataSource.maxDisplayLevel
, DataSource.maxDataLevel
, MapView.maxZoomLevel
, MapControls.maxZoomLevel
?
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.
As agreed for the time being we leave the semantic of those properties as-is, both edges inclusive.
Signed-off-by: German Zargaryan german.zargaryan@here.com
Thank you for contributing to harp.gl!
Before requesting a pull request, please remember to check the following documents:
If you are adding new functionality we would highly appreciate if you can describe what is the capability you are adding and even better if you can add some examples. Please also remember to add tests for it.
CI Check
Our bots will check whether your PR can be directly integrated into the mainline. We have some internal integration tests running on the background, our bots will inform you of the next steps and someone from our team will take a look and help if needed!
And please do not forget to sign-off your commit! You can read more about DCO here. But, in short, you just need to use
git commit -s
or append--signoff
when you are committing to the repo.Happy contributing!