Changelog entry for 3.35.4 #175374
Changelog entry for 3.35.4 #175374
Conversation
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the changelog for version 3.35.4. My review focuses on improving the clarity and formatting of the new entries to align with the project's documentation standards. I've suggested rephrasing the entries to describe the problem rather than the fix, which helps users better understand the changes. I also pointed out a potential typo in an iOS version number.
CHANGELOG.md
Outdated
| ## Flutter 3.35 Changes | ||
| ### [3.35.4](https://github.com/flutter/flutter/releases/tag/3.35.4) | ||
| - [flutter/173474](https://github.com/flutter/flutter/issues/173474) - On all platforms PlatformDispatchers.instance.engineId no longer returns null after hot restart. | ||
| - [flutter/174513](https://github.com/flutter/flutter/issues/174513) - On iOS 26 Fix a bug where platform view's gesture blocking fails and lets touches fall through to underlying flutter views. |
There was a problem hiding this comment.
This changelog entry could be more concise and clearer by removing 'Fix a bug' and rephrasing to describe the problem directly. This makes the documentation more useful for users trying to understand the change.1
Additionally, 'iOS 26' appears to be a typo, as this is not a valid iOS version number. Please verify and correct the iOS version this fix applies to. I have removed it in the suggestion, but please add the correct version if it is applicable.
| - [flutter/174513](https://github.com/flutter/flutter/issues/174513) - On iOS 26 Fix a bug where platform view's gesture blocking fails and lets touches fall through to underlying flutter views. | |
| - [flutter/174513](https://github.com/flutter/flutter/issues/174513) - On iOS, a platform view's gesture blocking could fail, allowing touches to fall through to underlying Flutter views. |
Style Guide References
Footnotes
-
Documentation should be useful and explain the 'why' and the 'how' to the reader. ↩
There was a problem hiding this comment.
@reidbaker correction: ... to fall through to underlying *platform* views
There was a problem hiding this comment.
How about: "On iOS 26, fix a bug hwere platform view's gesture blocking fails and lets touches on Flutter views fall through to underlying platform views"
|
|
||
| ## Flutter 3.35 Changes | ||
| ### [3.35.4](https://github.com/flutter/flutter/releases/tag/3.35.4) | ||
| - [flutter/173474](https://github.com/flutter/flutter/issues/173474) - On all platforms PlatformDispatchers.instance.engineId no longer returns null after hot restart. |
There was a problem hiding this comment.
The changelog entry describes the fix rather than the problem. To improve clarity for users, it's better to describe the problem that was fixed. This aligns with the principle of making documentation useful.1 Also, for better readability, PlatformDispatchers.instance.engineId should be enclosed in backticks.2
For reference, the CHANGELOG.md's own contribution guidelines state: 'Make sure that the text here helps customers understand whether they are likely to be affected by the issue, without them needing to read each issue individually.'
| - [flutter/173474](https://github.com/flutter/flutter/issues/173474) - On all platforms PlatformDispatchers.instance.engineId no longer returns null after hot restart. | |
| - [flutter/173474](https://github.com/flutter/flutter/issues/173474) - On all platforms, `PlatformDispatchers.instance.engineId` could return null after a hot restart. |
Style Guide References
Footnotes
reidbaker
added
the
autosubmit
auto-submit
bot
merged commit 11c0f07
into
flutter:flutter-3.35-candidate.0
5 participants
changelog entry update