Update Style-guide-for-Flutter-repo.md by goderbauer · Pull Request #161344 · flutter/flutter

goderbauer · 2025-01-08T23:27:22Z

This mainly removes guidance around whitespace that no longer applies because it is now handled automatically by dart format.

Piinks

What a clean up! Thank you!

Piinks · 2025-01-09T15:02:04Z

docs/contributing/Style-guide-for-Flutter-repo.md

 ### Get early feedback when designing new APIs

 If you're designing a new API or a new feature, consider [writing a design doc](Design-Documents.md).
-Then, get feedback from the relevant people, e.g. send it to `flutter-dev` or


Oh excellent catch

Piinks · 2025-01-09T15:04:45Z

docs/contributing/Style-guide-for-Flutter-repo.md

-  }
-});
-```
+### Prefer a maximum line length of 80 characters for comments and docs


Is this still 80? Or 100?

Currently, most of our doc comments are formatted to 80 chars. We could unify this to say they should also be 100 chars. I do want to avoid that people reflow existing comments to 100 chars, though, which would pollute PRs.

I am going to update this to say to prefer to keep them under 100 chars with a note that existing docs limited to 80 chars should not be reflowed just because of this.

Piinks · 2025-01-09T15:05:52Z

docs/contributing/Style-guide-for-Flutter-repo.md

-```
-
-
 ### Use braces for long functions and methods


I don't know if this is true anymore, didn't @nate-thegrate change this somewhere else in the style guide?

Hm, I didn't see anything about this in the guide. "### Consider using => for short functions and methods" two guidelines above still say to only use it for things that fit on one line.

Piinks · 2025-01-09T15:07:35Z

docs/contributing/Style-guide-for-Flutter-repo.md

-
 ### Use braces for long functions and methods

 Use a block (with braces) when a body would wrap onto more than one line (as opposed to using `=>`; the cases where you can use `=>` are discussed in the previous two guidelines).


Also, the previous two guidelines are being removed.

Previously, this statement was incorrect, now with the removal of the previous two guidelines it is correct that the new previously two guidelines actually talk about => usage again. :)

Ah! I see now, thanks!

Piinks

LGTM

Roll Flutter from 4b23b81 to 864d4f5 (50 revisions) flutter/flutter@4b23b81...864d4f5 2025-01-10 [email protected] Mark complex_layout_scroll_perf_macos__timeline_summary unflaky (flutter/flutter#160997) 2025-01-10 [email protected] Mark hello_world_macos__compile unflaky (flutter/flutter#160998) 2025-01-10 [email protected] Mark animated_complex_opacity_perf_macos__e2e_summary unflaky (flutter/flutter#160996) 2025-01-10 [email protected] Mark integration_ui_test_test_macos unflaky (flutter/flutter#160999) 2025-01-10 [email protected] Mark hot_mode_dev_cycle_macos_target__benchmark unflaky (flutter/flutter#161000) 2025-01-10 [email protected] Add a virtual-display (VD) platform view test, and refactor tests a bit. (flutter/flutter#161349) 2025-01-10 [email protected] Remove `CIRRUS_TASK_NAME` from what I can tell, is always omitted on `LUCI` (flutter/flutter#161391) 2025-01-10 [email protected] Replace the always omitted `CPU` environment variable with `numberOfProcessors`. (flutter/flutter#161392) 2025-01-10 [email protected] We no longer have a separate engine repo. (flutter/flutter#161400) 2025-01-10 [email protected] Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344) 2025-01-09 [email protected] integration_test: Add gitignore of golden image (flutter/flutter#161404) 2025-01-09 [email protected] Fix link to engine docs in CONTRIBUTING.md (flutter/flutter#161401) 2025-01-09 [email protected] Roll Packages from 3fc6b7a to 6554751 (11 revisions) (flutter/flutter#161379) 2025-01-09 [email protected] Add `mouseCursor` parameter to `ReorderableListView` (flutter/flutter#160246) 2025-01-09 [email protected] Remove Cirrus CI from Flutter goldens. (flutter/flutter#161396) 2025-01-09 [email protected] remove`useMaterial3: true,` in from the template (flutter/flutter#160525) 2025-01-09 [email protected] Remove `accept_android_sdk_licenses.sh`, which appears unused. (flutter/flutter#161388) 2025-01-09 [email protected] Roll Dart to Version 3.7.0-312.0.dev (flutter/flutter#161394) 2025-01-09 [email protected] Marks Linux analyzer_benchmark to be flaky (flutter/flutter#161307) 2025-01-09 [email protected] [Impeller] fix scaling of trampoline import of GLES textures into Vulkan. (flutter/flutter#161331) 2025-01-09 [email protected] Support DDC library bundle format and remove support for DDC module format (flutter/flutter#161276) 2025-01-09 [email protected] Remove seemingly stale web Cirrus and "Web Installer" instructions (flutter/flutter#161389) 2025-01-09 [email protected] Proposal to deprecate `webGoldenComparator`. (flutter/flutter#161196) 2025-01-09 [email protected] `ImplicitlyAnimatedWidgetState` code cleanup (flutter/flutter#160567) 2025-01-09 [email protected] Exclude `*texture*` as matching for `a: text input` (flutter/flutter#161354) 2025-01-09 [email protected] [Impeller] add opt in flag for SurfaceControl testing. (flutter/flutter#161353) 2025-01-09 [email protected] Roll Dart to Version 3.7.0-307.0.dev (flutter/flutter#161278) 2025-01-09 [email protected] remove formatter from snippet tool (flutter/flutter#161347) 2025-01-09 [email protected] Refactor keyboard manager tests (flutter/flutter#160637) 2025-01-09 [email protected] [flutter_tools] ignore viewpost ime and samsung spam messages. (flutter/flutter#161199) 2025-01-09 [email protected] Revert "[SwiftPM] Add separate feature flag for the app migration (#158897)" (flutter/flutter#161342) 2025-01-09 [email protected] git ignore .ccls-cache (flutter/flutter#161340) 2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[SwiftPM] Turn on by default (#161275)" (flutter/flutter#161339) 2025-01-08 [email protected] Update engine instructions for monorepo (flutter/flutter#161184) 2025-01-08 [email protected] [Impeller] re-enable Adreno 630 (flutter/flutter#161287) 2025-01-08 [email protected] [SwiftPM] Turn on by default (flutter/flutter#161275) 2025-01-08 [email protected] Make the encoding of a `YamlNode` to a `String` more explicit. (flutter/flutter#161270) 2025-01-08 [email protected] Normalize the translation column of the color matrix. (flutter/flutter#161109) 2025-01-08 [email protected] Rename `native_driver` to `android_{driver_extensions|engine_test}` (flutter/flutter#161263) 2025-01-08 [email protected] [Impeller] reland: fix porterduff shader and handle optimized out texture binding in GLES backend. (flutter/flutter#161326) 2025-01-08 [email protected] Updating AVD Dependency for Android 28 Emulator (flutter/flutter#160978) 2025-01-08 [email protected] Adds onHover and onLongPress to IconButton widget (flutter/flutter#160032) 2025-01-08 [email protected] Marks Linux linux_desktop_impeller to be unflaky (flutter/flutter#161302) 2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] porter duff workarounds for Adreno GPU. (#161273)" (flutter/flutter#161318) 2025-01-08 [email protected] Revert "fixed keyboardDismissBehavior on scroll without a drag" (flutter/flutter#161277) 2025-01-08 [email protected] Revert "use uuid from package:uuid instead of from package:usage" (flutter/flutter#161292) ...

goderbauer requested a review from Piinks January 8, 2025 23:27

github-actions bot added c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. d: docs/ flutter/flutter/docs, for contributors labels Jan 8, 2025

Update Style-guide-for-Flutter-repo.md

9106c67

goderbauer force-pushed the style branch from 47797ad to 9106c67 Compare January 8, 2025 23:27

Update Style-guide-for-Flutter-repo.md

d8cce42

Piinks reviewed Jan 9, 2025

View reviewed changes

Update Style-guide-for-Flutter-repo.md

7018d04

Piinks approved these changes Jan 9, 2025

View reviewed changes

goderbauer added this pull request to the merge queue Jan 10, 2025

Merged via the queue into flutter:master with commit daa4467 Jan 10, 2025

goderbauer deleted the style branch January 10, 2025 03:42

engine-flutter-autoroll mentioned this pull request Jan 10, 2025

Roll Flutter from 4b23b8182888 to 864d4f59dde0 (50 revisions) flutter/packages#8407

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 10, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

e5f0211

engine-flutter-autoroll mentioned this pull request Jan 10, 2025

Roll Flutter from 4b23b8182888 to 864d4f59dde0 (50 revisions) flutter/packages#8408

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 10, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

06142c3

Piinks mentioned this pull request Jan 11, 2025

Flutter Notable Commits - 2025 #161460

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

d39a717

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

4df2a94

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

ce7a4c5

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

c771d72

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025

daa4467 Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)

5677599

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Style-guide-for-Flutter-repo.md#161344

Update Style-guide-for-Flutter-repo.md#161344
goderbauer merged 3 commits intoflutter:masterfrom
goderbauer:style

goderbauer commented Jan 8, 2025

Uh oh!

Piinks left a comment

Uh oh!

Piinks Jan 9, 2025

Uh oh!

Piinks Jan 9, 2025

Uh oh!

goderbauer Jan 9, 2025

Uh oh!

goderbauer Jan 9, 2025

Uh oh!

Piinks Jan 9, 2025

Uh oh!

Piinks Jan 9, 2025

Uh oh!

goderbauer Jan 9, 2025

Uh oh!

Piinks Jan 9, 2025

Uh oh!

goderbauer Jan 9, 2025

Uh oh!

Piinks Jan 9, 2025

Uh oh!

Piinks left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		### Use braces for long functions and methods

		Use a block (with braces) when a body would wrap onto more than one line (as opposed to using `=>`; the cases where you can use `=>` are discussed in the previous two guidelines).

Conversation

goderbauer commented Jan 8, 2025

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants