update build doc string to advocate avoiding doing tasks other than b… #58213
Conversation
This file contains hidden or 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
|
It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat. Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. |
goderbauer
reviewed
Jun 3, 2020
Comment on lines
475
to
476
| /// This builder can get called arbitrarily and should not do anything beyond | ||
| /// building a widget. |
There was a problem hiding this comment.
Should we just say:
This builder must only return a widget and should not have any side effects as it may be called multiple times.
| @@ -686,6 +689,9 @@ class FutureBuilder<T> extends StatefulWidget { | |||
| /// the value to which the future completed. If it completed with an error, | |||
| /// [AsyncSnapshot.hasError] will be true and [AsyncSnapshot.error] will be | |||
| /// set to the error object. | |||
| /// | |||
| /// This builder can get called arbitrarily and should not do anything beyond | |||
| /// The framework calls this method when this widget is inserted into the tree | ||
| /// in a given [BuildContext] and when the dependencies of this widget change | ||
| /// (e.g., an [InheritedWidget] referenced by this widget changes). However, | ||
| /// these are not the only place this method gets called. This method can be |
There was a problem hiding this comment.
Maybe say something around that it could potentially be called every frame and should not have any side effects.
| @@ -1325,6 +1330,11 @@ abstract class State<T extends StatefulWidget> with Diagnosticable { | |||
| /// * After calling [deactivate] and then reinserting the [State] object into | |||
| /// the tree at another location. | |||
| /// | |||
| /// These are not the only place this method gets called. This method can be | |||
goderbauer
approved these changes
Jun 3, 2020
Comment on lines
668
to
669
| /// method can potentially be called in every frames, and you should keep in | ||
| /// mind that it should not have any side effects beyond building a widget. |
There was a problem hiding this comment.
per style guide: avoid empty phrases:
Suggested change
| /// method can potentially be called in every frames, and you should keep in | |
| /// mind that it should not have any side effects beyond building a widget. | |
| /// method can potentially be called in every frames and should not have any | |
| /// side effects beyond building a widget. |
| @@ -1325,6 +1328,9 @@ abstract class State<T extends StatefulWidget> with Diagnosticable { | |||
| /// * After calling [deactivate] and then reinserting the [State] object into | |||
| /// the tree at another location. | |||
| /// | |||
| /// This method can potentially be called in every frames, and you should keep | |||
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
…uilding a widget
Description
title said it all
Related Issues
Fixes #16218
Tests
I added the following tests:
doc only change
Checklist
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (
[x]). This will ensure a smooth and quick review process.///).flutter analyze --flutter-repo) does not report any problems on my PR.Breaking Change
Did any tests fail when you ran them? Please read Handling breaking changes.