Skip to content
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
merged 6 commits into from Apr 4, 2023
Merged

Conversation

gspencergoog
Copy link
Contributor

@gspencergoog gspencergoog commented Apr 4, 2023

Description

This PR renames the names of example classes so that MyApp, _MyAppState, MyStatefulWidget, _MyStatefulWidgetState, and MyStatelessWidget 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 an AppBar into the AppBar 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

  • Updated example tests to match the new example class names.

@flutter-dashboard 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 gspencergoog changed the title Rename list view examples Rename Sample classes Apr 4, 2023
@flutter-dashboard flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Apr 4, 2023
Copy link
Member

@loic-sharma loic-sharma left a 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 gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 4, 2023
@auto-submit auto-submit bot merged commit e3bc8ef into flutter:master Apr 4, 2023
69 checks passed
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
exaby73 pushed a commit to NevercodeHQ/flutter that referenced this pull request Apr 17, 2023
@QuncCccccc QuncCccccc mentioned this pull request Apr 18, 2023
8 tasks
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants