Various doc fixes #35548
Merged
Various doc fixes #35548
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
goderbauer
added
the
framework
Piinks
approved these changes
Jul 3, 2019
| /// Since [Container] combines a number of other widgets each with their own | ||
| /// layout behavior, [Container]'s layout behavior is somewhat complicated. | ||
| /// | ||
| /// tl;dr: [Container] tries, in order: to honor [alignment], to size itself to |
There was a problem hiding this comment.
Is tl;dr ok in API docs? Ref: #18542
| /// | ||
| /// tl;dr: [Container] tries, in order: to honor [alignment], to size itself to | ||
| /// the [child], to honor the `width`, `height`, and [constraints], to expand to | ||
| /// fit the parent, to be as small as possible. |
There was a problem hiding this comment.
Suggested change
| /// fit the parent, to be as small as possible. | |
| /// fit the parent, and to be as small as possible. |
There was a problem hiding this comment.
The and seems to make it ambitious.
| /// rules described above.) The [decoration] can implicitly increase the | ||
| /// [padding] (e.g. borders in a [BoxDecoration] contribute to the [padding]); | ||
| /// see [Decoration.padding]. | ||
| /// |
There was a problem hiding this comment.
Would a diagram for any of these scenarios listed above be beneficial in illustrating the point? Not sure.
There was a problem hiding this comment.
I'll leave that for a follow-up :)
|
On cirrus it shows that all checks passed: https://cirrus-ci.com/build/5674139195539456 Not sure why Github is disagreeing. Submitting. |
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.
Description
Takes the doc fixes from #33460 and applies them without making the analyzer mad. Also filed https://github.com/flutter/flutter/issues/35547 to allow "Sample Code" headings in the future and move the discussion around those to the issue.
/cc @Hixie @gspencergoog
Related Issues
None
Tests
I added the following tests:
None, 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
Does your PR require Flutter developers to manually update their apps to accommodate your change?