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
Rename Sample classes #124080
Merged
auto-submit
merged 6 commits into
flutter:master
from
gspencergoog:fix_example_class_names
Apr 4, 2023
Merged
Rename Sample classes #124080
auto-submit
merged 6 commits into
flutter:master
from
gspencergoog:fix_example_class_names
Apr 4, 2023
Conversation
This file contains 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
flutter-dashboard
bot
added
a: animation
Animation APIs
a: text input
Entering text in a text field or keyboard related problems
d: api docs
Issues with https://api.flutter.dev/
d: examples
Sample code and demos
documentation
f: cupertino
flutter/packages/flutter/cupertino repository
f: focus
Focus traversal, gaining or losing focus
f: gestures
flutter/packages/flutter/gestures repository.
f: material design
flutter/packages/flutter/material repository.
f: routes
Navigator, Router, and related APIs.
f: scrolling
Viewports, list views, slivers, etc.
team
Infra upgrades, team productivity, code health, technical debt. See also team: labels.
labels
Apr 4, 2023
gspencergoog
force-pushed
the
fix_example_class_names
branch
from
April 4, 2023 00:17
97b8f69
to
82a6f27
Compare
flutter-dashboard
bot
added
the
framework
flutter/packages/flutter repository. See also f: labels.
label
Apr 4, 2023
loic-sharma
reviewed
Apr 4, 2023
loic-sharma
reviewed
Apr 4, 2023
loic-sharma
reviewed
Apr 4, 2023
examples/api/lib/material/navigation_drawer/navigation_drawer.0.dart
Outdated
Show resolved
Hide resolved
loic-sharma
reviewed
Apr 4, 2023
loic-sharma
reviewed
Apr 4, 2023
loic-sharma
reviewed
Apr 4, 2023
examples/api/lib/widgets/editable_text/editable_text.on_content_inserted.0.dart
Outdated
Show resolved
Hide resolved
loic-sharma
reviewed
Apr 4, 2023
loic-sharma
approved these changes
Apr 4, 2023
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.
Thanks for going above and beyond! 🥇
gspencergoog
force-pushed
the
fix_example_class_names
branch
from
April 4, 2023 02:10
82a6f27
to
97a46eb
Compare
gspencergoog
force-pushed
the
fix_example_class_names
branch
from
April 4, 2023 18:52
97a46eb
to
9a84056
Compare
gspencergoog
added
the
autosubmit
Merge PR when tree becomes green via auto submit App
label
Apr 4, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 5, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 5, 2023
8 tasks
exaby73
pushed a commit
to NevercodeHQ/flutter
that referenced
this pull request
Apr 17, 2023
Rename Sample classes
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 10, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
a: animation
Animation APIs
a: text input
Entering text in a text field or keyboard related problems
autosubmit
Merge PR when tree becomes green via auto submit App
d: api docs
Issues with https://api.flutter.dev/
d: examples
Sample code and demos
f: cupertino
flutter/packages/flutter/cupertino repository
f: focus
Focus traversal, gaining or losing focus
f: gestures
flutter/packages/flutter/gestures repository.
f: material design
flutter/packages/flutter/material repository.
f: routes
Navigator, Router, and related APIs.
f: scrolling
Viewports, list views, slivers, etc.
framework
flutter/packages/flutter repository. See also f: labels.
team
Infra upgrades, team productivity, code health, technical debt. See also team: labels.
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.
Description
This PR renames the names of example classes so that
MyApp
,_MyAppState
,MyStatefulWidget
,_MyStatefulWidgetState
, andMyStatelessWidget
become class names that match the name of the example.It also fixes all the places where we had a comment like this:
// Flutter code sample for [SomeWidget].
and converts it to a doc comment like so:
/// Flutter code sample for [SomeWidget].
and moves it below the first import statement (to avoid triggering a lint).
This is so that examples viewed in an IDE have an active link back to the class they are meant to be showing an example of.
I also eliminated a bunch of places where we set the title on
MaterialApp
, and moved the const string for titles that are set on anAppBar
into theAppBar
declaration itself, and renamed any titles that were just "Flutter App Sample" to be more specific to the sample.The first commit in the PR contains some minor fixes for examples that didn't conform to the naming convention. The second PR contains the mechanical renames of the example widget classes.
Tests