Skip to content

Doc and Error Message Improvements#60726

Merged
fluttergithubbot merged 6 commits into
flutter:masterfrom
Piinks:docSprint
Jul 8, 2020
Merged

Doc and Error Message Improvements#60726
fluttergithubbot merged 6 commits into
flutter:masterfrom
Piinks:docSprint

Conversation

@Piinks

@Piinks Piinks commented Jul 2, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

A couple of weeks ago I did a quarantine doc sprint. 😷 These are the remnants that weren't merged in other PRs.
The goal was to de-clutter the issue tracker of highly upvoted documentation/error message bugs, or those that are also labeled as regressions and crashers.

This may be broken out further into more PRs for clarity. :)

Related Issues

Fixes #19445
Fixes #7659
Fixes #44128
Fixes #13861
Fixes #7703
Fixes #13013
Fixes #14842
Fixes #15423
Fixes #58371
Fixes #47764
Fixes #32701
Fixes #27386

Tests

Just doc changes or assertion refactoring for better messaging.

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.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

  • No, no existing tests failed, so this is not a breaking change.

@Piinks Piinks added a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels. a: animation Animation APIs f: cupertino flutter/packages/flutter/cupertino repository d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos a: quality A truly polished experience documentation a: error message Error messages from the Flutter framework a: annoyance Repeatedly frustrating issues with non-experimental functionality labels Jul 2, 2020
@fluttergithubbot

fluttergithubbot commented Jul 2, 2020

Copy link
Copy Markdown
Contributor

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.

@fluttergithubbot fluttergithubbot added the f: material design flutter/packages/flutter/material repository. label Jul 2, 2020
@Piinks Piinks requested a review from goderbauer July 6, 2020 16:49
goderbauer
goderbauer reviewed Jul 6, 2020
View reviewed changes

@goderbauer goderbauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Thanks for the clean-up!

Comment thread packages/flutter/lib/src/material/list_tile.dart Outdated
Comment thread packages/flutter/lib/src/painting/box_border.dart Outdated
Comment thread packages/flutter/lib/src/painting/box_border.dart Outdated
Comment thread packages/flutter/lib/src/painting/box_border.dart Outdated
Comment thread packages/flutter/lib/src/painting/box_border.dart Outdated
if (!_colorIsUniform) ErrorDescription('BorderSide.color'),
if (!_widthIsUniform) ErrorDescription('BorderSide.width'),
if (!_styleIsUniform) ErrorDescription('BorderSide.style'),
ErrorDescription('is not uniform.'),

@goderbauer goderbauer Jul 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This error will be grammatically incorrect (is vs. are) if more than one property is not uniform (assuming that can happen).

@Piinks Piinks Jul 6, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it is possible for more than one to be listed. I wasn't sure if it was worth handling the is/are. I've tried a tweak, let me know what you think. :)

Comment thread packages/flutter/lib/src/painting/box_border.dart Outdated
if (!_colorIsUniform) ErrorDescription('BorderSide.color'),
if (!_widthIsUniform) ErrorDescription('BorderSide.width'),
if (!_styleIsUniform) ErrorDescription('BorderSide.style'),
ErrorDescription('is not uniform.'),

@goderbauer goderbauer Jul 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here.

@Piinks Piinks Jul 6, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment above.

Comment thread packages/flutter/lib/src/widgets/basic.dart Outdated
Comment thread packages/flutter/lib/src/widgets/navigator.dart Outdated
goderbauer
goderbauer approved these changes Jul 7, 2020
View reviewed changes

@goderbauer goderbauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fluttergithubbot

fluttergithubbot commented Jul 7, 2020

Copy link
Copy Markdown
Contributor

This pull request is not suitable for automatic merging in its current state.

  • The status or check suite docs-linux has failed. Please fix the issues identified (or deflake) before re-applying this label.

@fluttergithubbot

fluttergithubbot commented Jul 7, 2020

Copy link
Copy Markdown
Contributor

This pull request is not suitable for automatic merging in its current state.

  • The status or check suite framework_tests-widgets-macos has failed. Please fix the issues identified (or deflake) before re-applying this label.

@fluttergithubbot fluttergithubbot merged commit 3176232 into flutter:master Jul 8, 2020
mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020
@Piinks @mingwandroid
Doc and Error Message Improvements (flutter#60726)
1539a87
@HansMuller HansMuller mentioned this pull request Dec 2, 2020
Merged
@Piinks Piinks mentioned this pull request Feb 17, 2021
Merged
8 tasks
@slosd slosd mentioned this pull request Mar 19, 2021
Closed
@marcglasberg marcglasberg mentioned this pull request Jul 25, 2021
Closed
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jul 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@goderbauer goderbauer goderbauer approved these changes
+1 more reviewer
@allanbatista-vwi allanbatista-vwi allanbatista-vwi approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

a: animation Animation APIs a: annoyance Repeatedly frustrating issues with non-experimental functionality a: error message Error messages from the Flutter framework a: quality A truly polished experience 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 f: cupertino flutter/packages/flutter/cupertino repository f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Unexpected top padding in ListView put inside scaffold with no appBar Better error message for sliver grid Improve documentation and assert for Stack.textDirection; also, API docs for Localizations should admit to adding a Directionality Poor messaging for assert when getting local coordinates of RenderBox: 'package:flutter/src/rendering/box.dart': Failed assertion: line 1342 Convert the box decoration border radius with non-uniform border assert into a detailed FlutterError
Improve the ListTile docs: explain the Text maxLines dependency Document that widgets in the overflow of stack do not respond to gestures AnimatedSize needs an example CupertinoButton in CupertinoNavigationBar as trailing gets cut Assertion failed: "onGenerateRoute" shows assertion when I try to go the same route for the 2nd time.

5 participants

@Piinks @fluttergithubbot @goderbauer @allanbatista-vwi @googlebot