Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Update changelog #359

Merged
merged 7 commits into from
Apr 30, 2020
Merged

Update changelog #359

merged 7 commits into from
Apr 30, 2020

Conversation

Chaoba
Copy link
Contributor

@Chaoba Chaoba commented Apr 29, 2020

This pr update changelog for 9.2.0-beta.1

@Chaoba Chaoba requested a review from chloekraw April 29, 2020 23:27
Copy link
Contributor

@chloekraw chloekraw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Chaoba. I'll push a commit to address my review comments as this is coming in late.

CHANGELOG.md Outdated
### Features
- The [`SymbolLayer.iconTextFit`](https://docs.mapbox.com/android/api/map-sdk/9.2.0-alpha.1/com/mapbox/mapboxsdk/style/layers/PropertyFactory.html#iconTextFit-com.mapbox.mapboxsdk.style.expressions.Expression-) property now respects the stretch metadata of any nine-part stretchable image passed into the `style.addImage` method. You can define the stretchable area of an image by configuring the `stretchX`, `stretchY`, `content` options on `Style.addImage` to append the requisite [metadata](https://github.com/mapbox/mapbox-gl-js/issues/8917). ([#314](https://github.com/mapbox/mapbox-gl-native-android/pull/314))
- Added methods to set and get the sort key of features in a `CircleLayer` at runtime. Features with a higher sort key will appear above features with a lower sort key. ([#322](https://github.com/mapbox/mapbox-gl-native-android/pull/322))
- Added `Source.maxOverscaleFactor` for defining the maximum factor by which a parent tile can be overscaled during rendering. This setting is only needed if a custom source on your map appears blurry or distorted when viewed at new zoom levels. ([#299](https://github.com/mapbox/mapbox-gl-native-android/pull/299))
- Added methods to set and get `volatile` in `Source`. Set `volatile` to false will store tiles in local cacje. ([#355](https://github.com/mapbox/mapbox-gl-native-android/pull/355))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I regret introducing this "Added methods to set and get..." syntax into our changelog 😅 I did it then because I was unsure how to properly represent style property APIs with our PropertyFactory class when writing the sort key entries.

In general, we don't need to continue this pattern; it's wordy, and most APIs have setters/getters so it doesn't contain meaningful information. :)

CHANGELOG.md Outdated
### Features
- The [`SymbolLayer.iconTextFit`](https://docs.mapbox.com/android/api/map-sdk/9.2.0-alpha.1/com/mapbox/mapboxsdk/style/layers/PropertyFactory.html#iconTextFit-com.mapbox.mapboxsdk.style.expressions.Expression-) property now respects the stretch metadata of any nine-part stretchable image passed into the `style.addImage` method. You can define the stretchable area of an image by configuring the `stretchX`, `stretchY`, `content` options on `Style.addImage` to append the requisite [metadata](https://github.com/mapbox/mapbox-gl-js/issues/8917). ([#314](https://github.com/mapbox/mapbox-gl-native-android/pull/314))
- Added methods to set and get the sort key of features in a `CircleLayer` at runtime. Features with a higher sort key will appear above features with a lower sort key. ([#322](https://github.com/mapbox/mapbox-gl-native-android/pull/322))
- Added `Source.maxOverscaleFactor` for defining the maximum factor by which a parent tile can be overscaled during rendering. This setting is only needed if a custom source on your map appears blurry or distorted when viewed at new zoom levels. ([#299](https://github.com/mapbox/mapbox-gl-native-android/pull/299))
- Added methods to set and get `volatile` in `Source`. Set `volatile` to false will store tiles in local cacje. ([#355](https://github.com/mapbox/mapbox-gl-native-android/pull/355))
- Added methods to set and get `minimumTileUpdateInterval` in `Source`. `minimumTileUpdateInterval` is used to throttle the tile update network requests([#355](https://github.com/mapbox/mapbox-gl-native-android/pull/355))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely understand how you got this changelog entry from the GL Native changelog 😅 I think this language is somewhat misleading, as I pointed out here. The main point of this feature is to allow a customer to override the server-side expiration (time-to-live or ttl) with a longer client-side ttl.

CHANGELOG.md Outdated

### Improvements and bug fixes
- Enabled adding style images on-demand on `MapSnapshotter`. ([#317](https://github.com/mapbox/mapbox-gl-native-android/pull/317))
- Fixed a crash when calling the `Style.removeImage` method with the name of a nonexistent image. ([#16391](https://github.com/mapbox/mapbox-gl-native/pull/16391))
- Fixed a crash when encountering an invalid polyline. ([#16409](https://github.com/mapbox/mapbox-gl-native/pull/16409))
- Certain logging statements no longer run on the main thread. ([#16325](https://github.com/mapbox/mapbox-gl-native/pull/16325))
- Improve the default compass engine's heading calculation and push updates even when uncertain. ([#338](https://github.com/mapbox/mapbox-gl-native-android/pull/338))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make sure to credit PR contributors in the changelog with (h/t @username) after the PR number

CHANGELOG.md Outdated

### Improvements and bug fixes
- Enabled adding style images on-demand on `MapSnapshotter`. ([#317](https://github.com/mapbox/mapbox-gl-native-android/pull/317))
- Fixed a crash when calling the `Style.removeImage` method with the name of a nonexistent image. ([#16391](https://github.com/mapbox/mapbox-gl-native/pull/16391))
- Fixed a crash when encountering an invalid polyline. ([#16409](https://github.com/mapbox/mapbox-gl-native/pull/16409))
- Certain logging statements no longer run on the main thread. ([#16325](https://github.com/mapbox/mapbox-gl-native/pull/16325))
- Improve the default compass engine's heading calculation and push updates even when uncertain. ([#338](https://github.com/mapbox/mapbox-gl-native-android/pull/338))
- Make `MapSnapshotter.ErrorHandler` be called in main thread. ([#341](https://github.com/mapbox/mapbox-gl-native-android/pull/341))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This linked to the wrong PR. Should be #347.

@chloekraw
Copy link
Contributor

cc @1ec5

Copy link
Contributor

@langsmith langsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@chloekraw chloekraw merged commit 8625168 into master Apr 30, 2020
@chloekraw chloekraw deleted the kl-changelog-9.2.0beta1 branch April 30, 2020 19:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants