Visitar URL original
Make dartdoc warnings fatal (& cleanup of warnings) by goderbauer · Pull Request #62367 · flutter/flutter · GitHub
Skip to content

Make dartdoc warnings fatal (& cleanup of warnings) - #62367

Merged
fluttergithubbot merged 2 commits into
flutter:masterfrom
goderbauer:moreDocFixes
Jul 28, 2020
Merged

Make dartdoc warnings fatal (& cleanup of warnings)#62367
fluttergithubbot merged 2 commits into
flutter:masterfrom
goderbauer:moreDocFixes

Conversation

@goderbauer

@goderbauer goderbauer commented Jul 27, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

Reviewers: Please ignore the first commit, it is a copy of #62317 to make cirrus happy.

Description

  • Make all warnings (except for unresolved doc reference) fatal
  • Fix all warnings except for unresolved doc reference
  • Fix unresolved doc references in:
    • painting library
    • scheduler library
    • services library
    • flutter_test
    • flutter_localizations
    • flutter_driver
    • semantics

The following packages still have unresolved doc references that need cleaning up:

Related Issues

#31931

Tests

I added the following tests:

  • doc only change, no tests

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.

@fluttergithubbot fluttergithubbot added p: cupertino_ui cupertino_ui package in flutter/packages p: material_ui material_ui package in flutter/packages framework flutter/packages/flutter repository. See also f: labels. work in progress; do not review labels Jul 27, 2020
@fluttergithubbot fluttergithubbot added a: internationalization Supporting other languages or locales. (aka i18n) a: tests "flutter test", flutter_test, or one of our tests c: contributor-productivity Team-specific productivity, code health, technical debt. labels Jul 28, 2020
@fluttergithubbot fluttergithubbot added the a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) label Jul 28, 2020
@goderbauer goderbauer changed the title More doc fixes Make dartdoc warnings fatal (& cleanup of warnings) Jul 28, 2020
@goderbauer
goderbauer marked this pull request as ready for review July 28, 2020 16:15
@goderbauer
goderbauer requested a review from Piinks as a code owner July 28, 2020 16:15
@goderbauer
goderbauer requested a review from tvolkert July 28, 2020 16:15
justinmc
justinmc approved these changes Jul 28, 2020
View reviewed changes

@justinmc justinmc 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, thanks for doing all this clean up 👍

@tvolkert

tvolkert commented Jul 28, 2020

Copy link
Copy Markdown
Contributor

#31931

@goderbauer

goderbauer commented Jul 28, 2020

Copy link
Copy Markdown
Member Author

#31931

Thanks! Added to PR description.

@goderbauer goderbauer mentioned this pull request Jul 28, 2020
Closed
@tvolkert

tvolkert commented Jul 28, 2020

Copy link
Copy Markdown
Contributor

FYI, #62317 has landed, so you can rebase this now.

@goderbauer

goderbauer commented Jul 28, 2020

Copy link
Copy Markdown
Member Author

FYI, #62317 has landed, so you can rebase this now.

Thanks. Already done :)

@fluttergithubbot

fluttergithubbot commented Jul 28, 2020

Copy link
Copy Markdown
Contributor

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

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

@goderbauer goderbauer mentioned this pull request Jul 28, 2020
Merged
9 of 13 tasks
@fluttergithubbot

fluttergithubbot commented Jul 28, 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 merged commit f4e10b4 into flutter:master Jul 28, 2020
@goderbauer
goderbauer deleted the moreDocFixes branch July 28, 2020 23:22
@goderbauer goderbauer mentioned this pull request Jul 29, 2020
Merged
9 of 13 tasks
Pragya007 pushed a commit to Pragya007/flutter that referenced this pull request Aug 11, 2020
@goderbauer @Pragya007
Make dartdoc warnings fatal (& cleanup of warnings) (flutter#62367)
6166b5e
mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020
@goderbauer @mingwandroid
Make dartdoc warnings fatal (& cleanup of warnings) (flutter#62367)
2d1feb9
@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

@justinmc justinmc justinmc approved these changes
@Piinks Piinks Awaiting requested review from Piinks
@tvolkert tvolkert Awaiting requested review from tvolkert

Assignees

No one assigned

Labels

a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) a: internationalization Supporting other languages or locales. (aka i18n) a: tests "flutter test", flutter_test, or one of our tests c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. p: cupertino_ui cupertino_ui package in flutter/packages p: material_ui material_ui package in flutter/packages

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@goderbauer @tvolkert @fluttergithubbot @justinmc @googlebot