Skip to content

Conversation

@goderbauer
Copy link
Member

@goderbauer goderbauer commented Jul 30, 2020

Description

Ensures that our dartdocs are free of warning and errors by failing the dartdoc check when any error/warning is present. All existing 812 warnings in our docs have been cleaned up.

Related Issues

Fixes #31931

Tests

I added the following tests:

n/a

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 c: contributor-productivity Team-specific productivity, code health, technical debt. work in progress; do not review labels Jul 30, 2020
@goderbauer goderbauer changed the title Make warnings fatal in dartdocs After cleaning up 812 warnings: Make warnings fatal in dartdocs Jul 30, 2020
@goderbauer goderbauer marked this pull request as ready for review July 30, 2020 20:08
@fluttergithubbot
Copy link
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.

@goderbauer goderbauer added framework flutter/packages/flutter repository. See also f: labels. and removed work in progress; do not review labels Jul 30, 2020
Copy link
Contributor

@gspencergoog gspencergoog left a comment

Choose a reason for hiding this comment

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

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

Ship it!

Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

LGTM! Well done! 🥳

- unknown-file
- missing-from-search-index
- unresolved-doc-reference
- orphaned-file
Copy link
Contributor

Choose a reason for hiding this comment

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

über nit: It appears these are organized alphabetically except for this one. 🤓

Copy link
Member Author

Choose a reason for hiding this comment

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

🤦 I will fix this in a follow-up PR (I want to submit this ASAP to avoid new warnings from sneaking in and pushing another commit would restart all the bots...)

Copy link
Member Author

Choose a reason for hiding this comment

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

As promised: #62611

Copy link
Contributor

@tvolkert tvolkert left a comment

Choose a reason for hiding this comment

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

I wish I had more than 1 LGTM to give.

@goderbauer
Copy link
Member Author

image

https://cirrus-ci.com/task/6049031900102656?command=main#L227

@goderbauer goderbauer merged commit 6ca8fda into flutter:master Jul 30, 2020
@goderbauer goderbauer deleted the enforceDartDoc branch July 30, 2020 21:11
Pragya007 pushed a commit to Pragya007/flutter that referenced this pull request Aug 11, 2020
mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020
@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.

Labels

c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Loads of unresolved doc references

6 participants