Skip to content

Make it an error to break doc macros (and fix existing broken macros) - #62071

Merged
goderbauer merged 1 commit into
flutter:masterfrom
goderbauer:doc-macro
Jul 23, 2020
Merged

goderbauer merged 1 commit into
flutter:masterfrom
goderbauer:doc-macro

Conversation

@goderbauer

Copy link
Copy Markdown
Member

Description

Fix all {@macro ...} usages in docs where no template could be found. Make it an error when a new unresolvable {@macro ...} directive is introduced.

Related Issues

#47652

Tests

I added the following tests:

Doc change only, dartdoc will now fail if an unresolved {@macro ...} is detected.

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: material_ui material_ui package in flutter/packages framework flutter/packages/flutter repository. See also f: labels. labels Jul 22, 2020
@fluttergithubbot

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

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-windows has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite framework_tests-libraries-windows has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite framework_tests-misc-windows has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite customer_testing-windows has failed. Please fix the issues identified (or deflake) before re-applying this label.

@goderbauer

Copy link
Copy Markdown
Member Author

Cirrus timed out. Restarted.

@goderbauer
goderbauer merged commit 4b4287b into flutter:master Jul 23, 2020
@goderbauer
goderbauer deleted the doc-macro branch July 23, 2020 15:29
zanderso added a commit that referenced this pull request Jul 23, 2020
@goderbauer goderbauer mentioned this pull request Jul 27, 2020
9 of 10 tasks
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

framework flutter/packages/flutter repository. See also f: labels. p: material_ui material_ui package in flutter/packages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants