Skip to content

Various doc fixes - #35548

Merged
goderbauer merged 2 commits into
flutter:masterfrom
goderbauer:Hixie-doc-fixes
Jul 9, 2019
Merged

goderbauer merged 2 commits into
flutter:masterfrom
goderbauer:Hixie-doc-fixes

Conversation

@goderbauer

@goderbauer goderbauer commented Jul 3, 2019 •

Copy link
Copy Markdown
Member

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.

  • 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 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

Does your PR require Flutter developers to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (Please read Handling breaking changes). Replace this with a link to the e-mail where you asked for input on this proposed change.
  • No, this is not a breaking change.

@goderbauer goderbauer added the framework flutter/packages/flutter repository. See also f: labels. label Jul 3, 2019

@Piinks Piinks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM +/- nits below. :)

/// 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is tl;dr ok in API docs? Ref: #18542

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed.

///
/// 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// fit the parent, to be as small as possible.
/// fit the parent, and to be as small as possible.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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].
///

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would a diagram for any of these scenarios listed above be beneficial in illustrating the point? Not sure.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'll leave that for a follow-up :)

@goderbauer

Copy link
Copy Markdown
Member Author

On cirrus it shows that all checks passed: https://cirrus-ci.com/build/5674139195539456

Not sure why Github is disagreeing. Submitting.

@goderbauer
goderbauer merged commit 4e973ad into flutter:master Jul 9, 2019
@goderbauer
goderbauer deleted the Hixie-doc-fixes branch July 9, 2019 00:02
johnsonmh pushed a commit to johnsonmh/flutter that referenced this pull request Jul 30, 2019
@goderbauer goderbauer mentioned this pull request Jun 18, 2020
9 of 13 tasks
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Aug 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants