-
Notifications
You must be signed in to change notification settings - Fork 3.5k
add describeEnum removal breaking change entry and migration guide
#13682
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
Open
AbdeMohlbi
wants to merge
7
commits into
flutter:main
Choose a base branch
from
AbdeMohlbi:describeEnum_removal
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−0
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
386fbb1
describeEnum removal
AbdeMohlbi dd42a01
small typo
AbdeMohlbi 8c092de
gemini comments
AbdeMohlbi 83bd310
Apply suggestion from @Piinks
AbdeMohlbi d1ed827
Apply suggestion from @Piinks
AbdeMohlbi e624768
piinks has a point
AbdeMohlbi 9e84c5b
that's even better
AbdeMohlbi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
58 changes: 58 additions & 0 deletions
58
sites/docs/src/content/release/breaking-changes/remove-describeEnum.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: Remove describeEnum | ||
| description: >- | ||
| The `describeEnum` method has been removed from the Flutter framework. | ||
| Since Dart 2.14, enums have a `name` getter that does the same thing. | ||
| --- | ||
|
|
||
| {% render "docs/breaking-changes.md" %} | ||
|
|
||
| ## Summary | ||
|
|
||
| The `describeEnum` method has been removed from the framework because it's redundant with the `name` | ||
| getter on `Enum` which was introduced in `Dart 2.14`. | ||
|
|
||
| ## Context | ||
|
|
||
| Historically, Flutter used `describeEnum` to return a `String` description of an enum value. | ||
| This became redundant when the `name` getter of `Enum` was introduced in `Dart 2.14`. | ||
|
|
||
| ## Migration guide | ||
|
|
||
| If your code previously used the `describeEnum` method to get the value name of an enum member, | ||
| migrate your code to use the `name` getter on the instance itself. | ||
|
|
||
| ```dart diff | ||
| enum Theme { light, dark } | ||
|
|
||
| - final theme = describeEnum(Theme.light); | ||
|
|
||
| + Theme.light.name; | ||
| ``` | ||
|
|
||
| :::important | ||
| This migration isn't supported by `dart fix`. | ||
| ::: | ||
|
|
||
| ## Timeline | ||
|
|
||
| Landed in version: TBD<br> | ||
| In stable release: TBD | ||
|
|
||
| ## References | ||
|
|
||
| API documentation: | ||
|
|
||
| * [`enums`][] | ||
|
|
||
|
|
||
| Relevant PRs: | ||
|
|
||
| * [PR 94496][] | ||
| * [PR 190076][] | ||
|
|
||
| [`enums`]: {{site.dart-site}}/language/enums | ||
| [PR 94496]: {{site.repo.flutter}}/pull/94496 | ||
| [PR 190076]: {{site.repo.flutter}}/pull/190076 | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
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.
Would be good to include the PR it was deprecated 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.
done