-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Deprecate describeEnum.
#125016
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
Deprecate describeEnum.
#125016
Conversation
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.
This appears to be a breaking change
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.
Could also be EnumProperty<Enum> extends DiagnosticsProperty<T>, what do you think?
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.
I don't know if customer_testing is a flake or what is happening there (the logs show success only, as far as I found), but I sent a PR to plugins already. Plugins don't use EnumProperty.
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.
Anyone who is using EnumProperty will be broken though. Should this be deprecated as well in favor of something new?
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.
I don't think so, because EnumProperty will be enforced to receive Enums, right now it is not enforced. It is used in tests 98% of the time, and by Flutter itself. I doubt it will break someone.
What would you do?
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.
What would you do?
I would not assume.
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.
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.
I searched here, most occurrences seems to be Flutter only, and these won't change anything because Flutter already uses Enum everywhere. https://github.com/search?type=code&auto_enroll=true&q=EnumProperty
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.
Can dart fix be added for this?
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.
I don't know. Can Dart fix replace describeEnum(something) with something.name?
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.
It might be, often the answer is to try it and see what happens. replacedBy might be the way to go, and if you look up the nullOk dart fix rules, that should be a good example of how to grab the argument.
276eeeb to
a7710b0
Compare
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.
The documentation above also needs to be updated.
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.
|
Have you looked at the customer_testing and flutter_plugins failure? |
|
Yes. I already submitted a PR for packages flutter/packages#3753 and I think customer might be a flake, because the log doesn't show anything, but I'll try to download and run manually later to see if anything hits. Edit: found it! It was a test that probably copied Flutter, but I believe Flutter changed and the test kept the same. I opened the PR there. |
2ce3a69 to
e0ec462
Compare
Tied to flutter/flutter#125016 --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
|
Since customer and plugin tests failed, this needs to follow the breaking change policy: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes |
|
I think I am following, I already submitted a PR for both and the docs to the website. Packages still used |
I'm deprecating `describeEnum` on Flutter (flutter/flutter#125016).
|
Progress:
|
Tied to flutter/flutter#125016 --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
* Adding state restoration pages (#8424) Fixes #2004 Fixes another issue that I can't find atm. [Staged link](https://sz-flutter-2.web.app/development/platform-integration/android/restore-state-android) @goderbauer, there are questions for you in this PR. cc @goderbauer --------- Co-authored-by: Parker Lougheed <[email protected]> * Fix typo "priori" -> "prior" (#8573) _Description of what this PR is changing or adding, and why:_ _Issues fixed by this PR (if any): Fix typo in `src/resources/inside-flutter.md:589` - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Brett Morgan <[email protected]> Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> * Replace Webby mention with I/O in banner (#8627) The Webby voting has ended. This PR removes the Webby mention and reintroduces the I/O call to action. <img width="559" alt="Screenshot of banner" src="https://user-images.githubusercontent.com/18372958/234385170-785d7be7-9b39-4752-b398-95a7e7f987a7.png"> Co-authored-by: Brett Morgan <[email protected]> * [Proposal] Breakup development directory (#8624) This pull request extracts all subcategories from `/development` to top-level entries, to match similar entries like "Deployment" and "Testing and debugging". The subcategories under Development are perhaps the most important categories for learning Flutter, but they were hidden under Development. This made them harder to navigate, with smaller text, and with deeper links and breadcrumbs. Work done: - Pulled subdirectories out of `/development` - Updated all old redirects and links to new destination - Introduce new redirects so old links keep working - Add some of the new top-level dividers to visually distinguish content - Enable breadcrumbs in moved content - Enable breadcrumbs within "Deployment" - Moved "Add to app" below "Deployment" - Add a short title for Add to app This is part of incremental work, and will be followed up with breaking up and reorganization "User interface", adjusting titles of content, and adding some cookbooks to the sidenav. Staged: https://flutter-docs-prod--pr8624-feature-breakup-deve-00ees3e9.web.app/ * Deprecate `describeEnum`. (#8571) Tied to flutter/flutter#125016 --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> * Moving migration guides to the release directory (#8629) Part of the IA cleanup, moving migration guides to the /release directory and removing them from the sidenav. cc @parlough --------- Co-authored-by: Parker Lougheed <[email protected]> * flavors.md - Updated path of "New Scheme" in the XCode menu. (#8599) Updated path of "New Scheme" in the XCode menu.  **IMPORTANT:** Due to work on the docs.flutter.dev infrastructure, **all open pull requests will be closed April 26.** If your PR needs to be merged by April 26, please say that in your PR. Otherwise, please [file an issue](https://github.com/flutter/website/issues/new/choose) about the needed change, and (if you submit a PR) be prepared to recreate the PR May 10 or later. --- _Description of what this PR is changing or adding, and why:_ _Issues fixed by this PR (if any):_ - [ ] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [ ] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. * Bump site-shared from `04a5353` to `74292e2` (#8630) * Fix apostrophe in contextual-survey-metadata.json (#8631) Changing apostrophe character in description --- Makes it so that we can parse the json in dart code in the response * Document the new `canvasKitVariant` runtime configuration (#8475) Add documentation for the new [`canvasKitVariant`](https://github.com/flutter/engine/blob/0776f38b87137ad2535d77e91a79b8b6c80f16fb/lib/web_ui/lib/src/engine/configuration.dart#L221-L224) runtime configuration. Closes flutter/flutter#123048 - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Anthony Sansone <[email protected]> * Adding wireless debugging information to the docs (#8456) We've added support for wireless debugging of iOS devices. This PR adds documentation for setting it up. To do: - [x] Add in information about IPv4 and IPv6 to `flutter attach` page - [ ] Specify the Flutter release where this feature is available - [x] See if there's any information needed for Android wireless debugging _Issues fixed by this PR (if any):_ #8425 - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Victoria Ashworth <[email protected]> Co-authored-by: Brett Morgan <[email protected]> Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> * Adaptation information for inputs and app bars (#8509) This PR adds some information on how to adapt styling for input widgets with .adaptive() constructors, as well as top app bars. Note that I am not sure of the best way to style the tables or size the images. Also, I have added some commented out sections that should be added when stable release goes live. Fixes: #8428 - [X] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [X] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [X] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. @MitchellGoodwin could you take a quick peak at the code and make sure it looks okay? @InMatrix feel free to propose any edits! --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> * Adapting bottom navigation bar (#8541) This adds to our platform adaptation documentation to add a section on tab bars. This fixes this issue: https://github.com/flutter/website/issues/8540. Builds on top of this PR: #8509 - [X] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [X] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [X] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> Co-authored-by: Anthony Sansone <[email protected]> * Updated Impeller details (#8607) Fixes #8608 --------- Co-authored-by: Loïc Sharma <[email protected]> * Enable build checks and tests in next branch (#8609) * Update widget catalog to show Material 3 widgets (#8574) Fixes #8432. Site changes are viewable at the staging site: https://flutter-site-73ed1.web.app/development/ui/widgets/. Primary changes: - Addition of Material 3 Components card [(view)](https://flutter-site-73ed1.web.app/development/ui/widgets/). - New Material 3 page showing M3 widgets as displayed in matching categories to material.io/components. This also includes a note about Material 3 becoming the default - this text is not final and can be iterated on in review. - Widget cards in the M3 page have a hover effect applied. - In the widgets overview page, Material now links to M3, and contains a link to the previous M2 widgets page. General notes: - Material 2 page ~~remains unchanged~~ has a notice about Material 3. - No light/dark modes - this was explored but decided against, with the possibility of returning to it if the site undergoes a site-wide dark mode addition. - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. * Updated the threading notice for platform channel responses. (#7901) This updates the guidelines about threading and the responses to platform channels. Once the following PRs are on `main` all official platforms (minus web where it doesn't make sense) support thread-safe responses. issue: flutter/flutter#93945 Do no land until the following are on stable: 1) flutter/engine#37689 1) flutter/engine#37607 1) flutter/engine#36909 - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> Co-authored-by: Parker Lougheed <[email protected]> * Update PR Template for Website Freeze (#8632) --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]> Co-authored-by: Parker Lougheed <[email protected]> Co-authored-by: 失魂魚 <[email protected]> Co-authored-by: Brett Morgan <[email protected]> Co-authored-by: Bernardo Ferrari <[email protected]> Co-authored-by: Dimitris Paxinos <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Elias Yishak <[email protected]> Co-authored-by: Mouad Debbar <[email protected]> Co-authored-by: Anthony Sansone <[email protected]> Co-authored-by: Leigha Jarett <[email protected]> Co-authored-by: Victoria Ashworth <[email protected]> Co-authored-by: Loïc Sharma <[email protected]> Co-authored-by: Eilidh Southren <[email protected]> Co-authored-by: gaaclarke <[email protected]>
494771e to
ddbe3be
Compare
6d43600 to
bc939b4
Compare
|
auto label is removed for flutter/flutter/125016, due to - The status or check suite Linux framework_tests_libraries has failed. Please fix the issues identified (or deflake) before re-applying this label. |
This fixes/notates a few deprecations from an audit for the next tech debt cycle. - ThemeData errorColor and backgroundColor are notated as deprecated in multiple places, but one usage had a different version tag. Updated to match the rest. - ThemeData.copyWith useMaterial3 was deprecated because it did not do what developers expected - it did not automatically reassign all of the color values and such. (confirmed with @HansMuller) I added a note so that when we later remove it we don't introduce a bug. - the describeEnum deprecation was tagged wrong, it was a very long PR so by the time it merged the version it was finally tagged with was much later. (#125016)
I'm deprecating `describeEnum` on Flutter (flutter/flutter#125016).


Final part of #123346.