-
Notifications
You must be signed in to change notification settings - Fork 27.1k
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
Remove 'must be non-null' and 'must not be null' comments from material. #134991
Merged
auto-submit
merged 4 commits into
flutter:master
from
gspencergoog:remove_null_comments_material
Sep 20, 2023
Merged
Remove 'must be non-null' and 'must not be null' comments from material. #134991
auto-submit
merged 4 commits into
flutter:master
from
gspencergoog:remove_null_comments_material
Sep 20, 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
github-actions
bot
added
a: text input
Entering text in a text field or keyboard related problems
framework
flutter/packages/flutter repository. See also f: labels.
f: material design
flutter/packages/flutter/material repository.
f: scrolling
Viewports, list views, slivers, etc.
labels
Sep 19, 2023
This was referenced Sep 19, 2023
Merged
auto-submit bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…amework libraries (#134994) ## Description This removes all of the comments that are of the form "so-and-so must not be null" or "so-and-so must be non-null" from the cases where those values are defines as non-nullable values. This PR removes them from the library in the repo that don't have anything to do with the framework. This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some. In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow. This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these). ## Related PRs - #134984 - #134991 - #134992 - #134993 ## Tests - Documentation only change.
goderbauer
approved these changes
Sep 19, 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.
LGTM!! 💙
gspencergoog
force-pushed
the
remove_null_comments_material
branch
2 times, most recently
from
September 19, 2023 18:15
bc9f481
to
7c4e3d2
Compare
gspencergoog
added
the
autosubmit
Merge PR when tree becomes green via auto submit App
label
Sep 19, 2023
auto-submit
bot
removed
the
autosubmit
Merge PR when tree becomes green via auto submit App
label
Sep 19, 2023
auto label is removed for flutter/flutter/134991, due to - The status or check suite Windows build_tests_5_5 has failed. Please fix the issues identified (or deflake) before re-applying this label.
|
gspencergoog
force-pushed
the
remove_null_comments_material
branch
from
September 19, 2023 20:43
7d2b0bd
to
3ecc6b6
Compare
gspencergoog
added
autosubmit
Merge PR when tree becomes green via auto submit App
team
Infra upgrades, team productivity, code health, technical debt. See also team: labels.
c: tech-debt
Technical debt, code quality, testing, etc.
d: api docs
Issues with https://api.flutter.dev/
and removed
a: text input
Entering text in a text field or keyboard related problems
framework
flutter/packages/flutter repository. See also f: labels.
f: material design
flutter/packages/flutter/material repository.
f: scrolling
Viewports, list views, slivers, etc.
labels
Sep 19, 2023
auto-submit
bot
removed
the
autosubmit
Merge PR when tree becomes green via auto submit App
label
Sep 19, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 21, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 22, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 22, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 22, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 22, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 22, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Sep 22, 2023
auto-submit bot
pushed a commit
to flutter/packages
that referenced
this pull request
Sep 23, 2023
…4985) Manual roll Flutter from 893650416352 to f92884c7b846 (48 revisions) Manual roll requested by [email protected] flutter/flutter@8936504...f92884c 2023-09-21 [email protected] Rename `debugProfilePlatformChannels` to a constant that works in release mode (flutter/flutter#134922) 2023-09-20 82763757 [email protected] Mark ReastaurationManager not disposed (flutter/flutter#134832) 2023-09-20 82763757 [email protected] cover more tests with leak tracing (flutter/flutter#134834) 2023-09-20 82763757 [email protected] Fix leak in hardware_keyboard_test.dart (flutter/flutter#134380) 2023-09-20 [email protected] Fix memory leak in _SelectableTextState (flutter/flutter#135049) 2023-09-20 [email protected] Roll Flutter Engine from 39c0f2ea1f53 to 89d864552acd (4 revisions) (flutter/flutter#135169) 2023-09-20 [email protected] [deps] Update package:web dependency. (flutter/flutter#135174) 2023-09-20 [email protected] finer grained logging of Chromium launch sequence (flutter/flutter#135078) 2023-09-20 34871572 [email protected] Upgrade AGP version in tracing_tests (flutter/flutter#134671) 2023-09-20 82763757 [email protected] Cover cupertino/form_section_test with leak tracing (flutter/flutter#135158) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking #7 (flutter/flutter#134943) 2023-09-20 [email protected] Enable strict-inference (flutter/flutter#135043) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking #10 (flutter/flutter#135143) 2023-09-20 82763757 [email protected] cover more tests with leak tracing (flutter/flutter#134833) 2023-09-20 [email protected] codeisn extension safe iOS framework (flutter/flutter#134966) 2023-09-20 [email protected] Roll Flutter Engine from 6f256257b79f to 55314d08d792 (2 revisions) (flutter/flutter#135151) 2023-09-20 [email protected] Remove 'must be non-null' and 'must not be null' comments in widgets library (flutter/flutter#134992) 2023-09-20 [email protected] Roll Flutter Engine from 5f82fc2f6f24 to 6f256257b79f (1 revision) (flutter/flutter#135147) 2023-09-20 43054281 [email protected] [Android] Add Java/AGP/Gradle incompatibility warning to `flutter create` (flutter/flutter#131444) 2023-09-20 [email protected] Roll Packages from d4e2454 to 51e74b9 (12 revisions) (flutter/flutter#135145) 2023-09-20 [email protected] Remove 'must not be null' comments from various libraries. (flutter/flutter#134984) 2023-09-20 [email protected] Roll Flutter Engine from 6535421b30d3 to 5f82fc2f6f24 (2 revisions) (flutter/flutter#135142) 2023-09-20 [email protected] Roll Flutter Engine from 67d4aaef3c7b to 6535421b30d3 (1 revision) (flutter/flutter#135139) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking #8 (flutter/flutter#135045) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking #9 (flutter/flutter#135054) 2023-09-20 [email protected] Roll Flutter Engine from 83b4df415bf3 to 67d4aaef3c7b (1 revision) (flutter/flutter#135128) 2023-09-20 [email protected] Roll Flutter Engine from df4e6c079682 to 83b4df415bf3 (2 revisions) (flutter/flutter#135102) 2023-09-20 [email protected] Roll Flutter Engine from 9c6b2500282b to df4e6c079682 (1 revision) (flutter/flutter#135101) 2023-09-20 [email protected] Roll Flutter Engine from 24f7ac38dfa2 to 9c6b2500282b (3 revisions) (flutter/flutter#135098) 2023-09-20 [email protected] Roll Flutter Engine from 36379b62bec8 to 24f7ac38dfa2 (2 revisions) (flutter/flutter#135096) 2023-09-20 [email protected] Roll Flutter Engine from 81b93fc4a2cc to 36379b62bec8 (2 revisions) (flutter/flutter#135095) 2023-09-20 [email protected] Roll Flutter Engine from 5a924a9017d7 to 81b93fc4a2cc (2 revisions) (flutter/flutter#135093) 2023-09-20 [email protected] Remove 'must be non-null' and 'must not be null' comments from material. (flutter/flutter#134991) 2023-09-20 34871572 [email protected] Unpin url launcher (remake) (flutter/flutter#134958) 2023-09-20 [email protected] Roll Flutter Engine from a7af55c56aa6 to 5a924a9017d7 (10 revisions) (flutter/flutter#135085) 2023-09-20 [email protected] Manual roll Flutter Engine from a7af55c56aa6 to 0d7db40c27fd (7 revisions) (flutter/flutter#135079) 2023-09-20 [email protected] Remove 'must not be null' comments from painting and rendering libraries. (flutter/flutter#134993) 2023-09-20 82763757 [email protected] cover more tests with leak tracking (flutter/flutter#134837) 2023-09-20 [email protected] [flutter roll] Revert "Native assets support for Linux" (flutter/flutter#135069) 2023-09-20 [email protected] Manual roll Flutter Engine from 10c480310926 to a7af55c56aa6 (4 revisions) (flutter/flutter#135071) 2023-09-19 [email protected] Retry Linux web tests 1 time on roll presubmit (flutter/flutter#135073) 2023-09-19 [email protected] [web] Encode AssetManifest.bin as JSON and use that on the web. (flutter/flutter#131382) 2023-09-19 [email protected] Specify suggested format in doc comment. (flutter/flutter#134887) 2023-09-19 [email protected] Manual roll Flutter Engine from 28f14e6eec4f to 10c480310926 (6 revisions) (flutter/flutter#135066) ...
Mairramer
pushed a commit
to Mairramer/flutter
that referenced
this pull request
Oct 10, 2023
…amework libraries (flutter#134994) ## Description This removes all of the comments that are of the form "so-and-so must not be null" or "so-and-so must be non-null" from the cases where those values are defines as non-nullable values. This PR removes them from the library in the repo that don't have anything to do with the framework. This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some. In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow. This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these). ## Related PRs - flutter#134984 - flutter#134991 - flutter#134992 - flutter#134993 ## Tests - Documentation only change.
Mairramer
pushed a commit
to Mairramer/flutter
that referenced
this pull request
Oct 10, 2023
…ies. (flutter#134993) ## Description This removes all of the comments that are of the form "so-and-so (must not be null|can ?not be null|must be non-null)" from the cases where those values are defines as non-nullable values. This PR removes them from the painting and rendering libraries. This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some. In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow. This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these). ## Related PRs - flutter#134984 - flutter#134991 - flutter#134992 - flutter#134994 ## Tests - Documentation only change.
Mairramer
pushed a commit
to Mairramer/flutter
that referenced
this pull request
Oct 10, 2023
…al. (flutter#134991) ## Description This removes all of the comments that are of the form "so-and-so (must not be null|can ?not be null|must be non-null)" from the cases where those values are defines as non-nullable values. This PR removes them from the material library. This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some. In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow. This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these). ## Related PRs - flutter#134984 - flutter#134992 - flutter#134993 - flutter#134994 ## Tests - Documentation only change.
Mairramer
pushed a commit
to Mairramer/flutter
that referenced
this pull request
Oct 10, 2023
…34984) ## Description This removes all of the comments that are of the form "so-and-so (must not be null|can ?not be null|must be non-null)" from the cases where those values are defines as non-nullable values. This PR removes them from the animation, cupertino, foundation, gestures, semantics, and services libraries. Each of them only had a few, so I lumped them together. This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some. In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow. This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these). ## Related PRs - flutter#134991 - flutter#134992 - flutter#134993 - flutter#134994 ## Tests - Documentation only change.
Mairramer
pushed a commit
to Mairramer/flutter
that referenced
this pull request
Oct 10, 2023
…library (flutter#134992) ## Description This removes all of the comments that are of the form "so-and-so (must not be null|can ?not be null|must be non-null)" from the cases where those values are defines as non-nullable values. This PR removes them from the widgets library. This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some. In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow. This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these). ## Related PRs - flutter#134984 - flutter#134991 - flutter#134993 - flutter#134994 ## Tests - Documentation only change.
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Nov 15, 2023
HugoOlthof
pushed a commit
to moneybird/packages
that referenced
this pull request
Dec 13, 2023
…lutter#4985) Manual roll Flutter from 893650416352 to f92884c7b846 (48 revisions) Manual roll requested by [email protected] flutter/flutter@8936504...f92884c 2023-09-21 [email protected] Rename `debugProfilePlatformChannels` to a constant that works in release mode (flutter/flutter#134922) 2023-09-20 82763757 [email protected] Mark ReastaurationManager not disposed (flutter/flutter#134832) 2023-09-20 82763757 [email protected] cover more tests with leak tracing (flutter/flutter#134834) 2023-09-20 82763757 [email protected] Fix leak in hardware_keyboard_test.dart (flutter/flutter#134380) 2023-09-20 [email protected] Fix memory leak in _SelectableTextState (flutter/flutter#135049) 2023-09-20 [email protected] Roll Flutter Engine from 39c0f2ea1f53 to 89d864552acd (4 revisions) (flutter/flutter#135169) 2023-09-20 [email protected] [deps] Update package:web dependency. (flutter/flutter#135174) 2023-09-20 [email protected] finer grained logging of Chromium launch sequence (flutter/flutter#135078) 2023-09-20 34871572 [email protected] Upgrade AGP version in tracing_tests (flutter/flutter#134671) 2023-09-20 82763757 [email protected] Cover cupertino/form_section_test with leak tracing (flutter/flutter#135158) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking flutter#7 (flutter/flutter#134943) 2023-09-20 [email protected] Enable strict-inference (flutter/flutter#135043) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking flutter#10 (flutter/flutter#135143) 2023-09-20 82763757 [email protected] cover more tests with leak tracing (flutter/flutter#134833) 2023-09-20 [email protected] codeisn extension safe iOS framework (flutter/flutter#134966) 2023-09-20 [email protected] Roll Flutter Engine from 6f256257b79f to 55314d08d792 (2 revisions) (flutter/flutter#135151) 2023-09-20 [email protected] Remove 'must be non-null' and 'must not be null' comments in widgets library (flutter/flutter#134992) 2023-09-20 [email protected] Roll Flutter Engine from 5f82fc2f6f24 to 6f256257b79f (1 revision) (flutter/flutter#135147) 2023-09-20 43054281 [email protected] [Android] Add Java/AGP/Gradle incompatibility warning to `flutter create` (flutter/flutter#131444) 2023-09-20 [email protected] Roll Packages from d4e2454 to 51e74b9 (12 revisions) (flutter/flutter#135145) 2023-09-20 [email protected] Remove 'must not be null' comments from various libraries. (flutter/flutter#134984) 2023-09-20 [email protected] Roll Flutter Engine from 6535421b30d3 to 5f82fc2f6f24 (2 revisions) (flutter/flutter#135142) 2023-09-20 [email protected] Roll Flutter Engine from 67d4aaef3c7b to 6535421b30d3 (1 revision) (flutter/flutter#135139) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking flutter#8 (flutter/flutter#135045) 2023-09-20 [email protected] Cover more test/widgets tests with leak tracking flutter#9 (flutter/flutter#135054) 2023-09-20 [email protected] Roll Flutter Engine from 83b4df415bf3 to 67d4aaef3c7b (1 revision) (flutter/flutter#135128) 2023-09-20 [email protected] Roll Flutter Engine from df4e6c079682 to 83b4df415bf3 (2 revisions) (flutter/flutter#135102) 2023-09-20 [email protected] Roll Flutter Engine from 9c6b2500282b to df4e6c079682 (1 revision) (flutter/flutter#135101) 2023-09-20 [email protected] Roll Flutter Engine from 24f7ac38dfa2 to 9c6b2500282b (3 revisions) (flutter/flutter#135098) 2023-09-20 [email protected] Roll Flutter Engine from 36379b62bec8 to 24f7ac38dfa2 (2 revisions) (flutter/flutter#135096) 2023-09-20 [email protected] Roll Flutter Engine from 81b93fc4a2cc to 36379b62bec8 (2 revisions) (flutter/flutter#135095) 2023-09-20 [email protected] Roll Flutter Engine from 5a924a9017d7 to 81b93fc4a2cc (2 revisions) (flutter/flutter#135093) 2023-09-20 [email protected] Remove 'must be non-null' and 'must not be null' comments from material. (flutter/flutter#134991) 2023-09-20 34871572 [email protected] Unpin url launcher (remake) (flutter/flutter#134958) 2023-09-20 [email protected] Roll Flutter Engine from a7af55c56aa6 to 5a924a9017d7 (10 revisions) (flutter/flutter#135085) 2023-09-20 [email protected] Manual roll Flutter Engine from a7af55c56aa6 to 0d7db40c27fd (7 revisions) (flutter/flutter#135079) 2023-09-20 [email protected] Remove 'must not be null' comments from painting and rendering libraries. (flutter/flutter#134993) 2023-09-20 82763757 [email protected] cover more tests with leak tracking (flutter/flutter#134837) 2023-09-20 [email protected] [flutter roll] Revert "Native assets support for Linux" (flutter/flutter#135069) 2023-09-20 [email protected] Manual roll Flutter Engine from 10c480310926 to a7af55c56aa6 (4 revisions) (flutter/flutter#135071) 2023-09-19 [email protected] Retry Linux web tests 1 time on roll presubmit (flutter/flutter#135073) 2023-09-19 [email protected] [web] Encode AssetManifest.bin as JSON and use that on the web. (flutter/flutter#131382) 2023-09-19 [email protected] Specify suggested format in doc comment. (flutter/flutter#134887) 2023-09-19 [email protected] Manual roll Flutter Engine from 28f14e6eec4f to 10c480310926 (6 revisions) (flutter/flutter#135066) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
autosubmit
Merge PR when tree becomes green via auto submit App
c: tech-debt
Technical debt, code quality, testing, etc.
d: api docs
Issues with https://api.flutter.dev/
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 removes all of the comments that are of the form "so-and-so (must not be null|can ?not be null|must be non-null)" from the cases where those values are defines as non-nullable values.
This PR removes them from the material library.
This was done by hand, since it really didn't lend itself to scripting, so it needs to be more than just spot-checked, I think. I was careful to leave any comment that referred to parameters that were nullable, but I may have missed some.
In addition to being no longer relevant after null safety has been made the default, these comments were largely fragile, in that it was easy for them to get out of date, and not be accurate anymore anyhow.
This did create a number of constructor comments which basically say "Creates a [Foo].", but I don't really know how to avoid that in a large scale change, since there's not much you can really say in a lot of cases. I think we might consider some leniency for constructors to the "Comment must be meaningful" style guidance (which we de facto have already, since there are a bunch of these).
Related PRs
Tests