Skip to content

Conversation

@gspencergoog
Copy link
Contributor

@gspencergoog gspencergoog commented Jul 13, 2023

Description

This adds a checker that will check all of the API docs examples to make sure that they are linked from at least one source file in the packages.

It also checks to make sure that all of the examples have an associated test. Since there are a large number that don't have tests at the moment, there is also a large exception list that can be burned down (burn down list is in #130459).

Because there are missing links currently, this PR will only pass after #130521 is merged.

Related Issues

Tests

  • Added test for the checker.

@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Jul 13, 2023
@github-actions github-actions bot removed framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Jul 13, 2023
@gspencergoog gspencergoog requested a review from guidezpl July 13, 2023 22:00
Copy link
Member

@guidezpl guidezpl left a comment

Choose a reason for hiding this comment

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

Nice!

auto-submit bot pushed a commit that referenced this pull request Jul 17, 2023
## Description

This adds some more missing example links.

I also wrote another PR for adding a check to make sure that examples are all linked from a source file and have tests: #130523

## Related Issues
 - #129956

## Tests
 - Documentation and refactoring only.
@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Jul 17, 2023
@gspencergoog gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 18, 2023
@auto-submit auto-submit bot merged commit 8b768de into flutter:master Jul 18, 2023
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Jul 19, 2023
Roll Flutter from 6f09064 to d07e8ae (60 revisions)

flutter/flutter@6f09064...d07e8ae

2023-07-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 09389b16d684 to eb2285205f25 (3 revisions) (flutter/flutter#130879)
2023-07-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0293a7cb7887 to 09389b16d684 (5 revisions) (flutter/flutter#130867)
2023-07-19 72562119+tgucio@users.noreply.github.com Move TapAndDragGestureRecognizer code under gestures (flutter/flutter#119508)
2023-07-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 29de67c7d009 to 0293a7cb7887 (1 revision) (flutter/flutter#130858)
2023-07-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 39d60be72ffb to 29de67c7d009 (4 revisions) (flutter/flutter#130855)
2023-07-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from b3bfc744bb61 to 39d60be72ffb (1 revision) (flutter/flutter#130847)
2023-07-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from adf6142f6738 to b3bfc744bb61 (7 revisions) (flutter/flutter#130843)
2023-07-18 leroux_bruno@yahoo.fr Update app_builder_test.dart for M3 (flutter/flutter#130794)
2023-07-18 ian@hixie.ch Catch errors in loadStructuredData (flutter/flutter#130748)
2023-07-18 5236035+fzyzcjy@users.noreply.github.com Fix super tiny space formatting (hope we have auto formatter in the future) (flutter/flutter#127479)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 71bbecee3010 to adf6142f6738 (2 revisions) (flutter/flutter#130831)
2023-07-18 leroux_bruno@yahoo.fr Update SnackBar tests for M2/M3 (flutter/flutter#130717)
2023-07-18 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#130821)
2023-07-18 thkim1011@users.noreply.github.com Relax syntax for gen-l10n (flutter/flutter#130736)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 45851af55bd6 to 71bbecee3010 (7 revisions) (flutter/flutter#130820)
2023-07-18 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#130608)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 831da7e9dc3b to 45851af55bd6 (2 revisions) (flutter/flutter#130814)
2023-07-18 43054281+camsim99@users.noreply.github.com [Android] Deletes deprecated splash screen meta-data element (flutter/flutter#130744)
2023-07-18 hans.muller@gmail.com Updated `ThemeData.useMaterial3` API doc, default is `true` (flutter/flutter#130764)
2023-07-18 chillers@google.com [labeler] Mark sync-labels as empty (flutter/flutter#130642)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from c27658cc5ade to 831da7e9dc3b (2 revisions) (flutter/flutter#130810)
2023-07-18 engine-flutter-autoroll@skia.org Roll Packages from 6889cca to 3e8b813 (9 revisions) (flutter/flutter#130802)
2023-07-18 tessertaha@gmail.com Update `AppBar` and `AppBarTheme` tests for M2/M3 (flutter/flutter#130790)
2023-07-18 leroux_bruno@yahoo.fr Update app tests for M3 (flutter/flutter#130792)
2023-07-18 gspencergoog@users.noreply.github.com Add lint check to make sure samples are linked and have tests (flutter/flutter#130523)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from aaec42812a1f to c27658cc5ade (2 revisions) (flutter/flutter#130799)
2023-07-18 109111084+yaakovschectman@users.noreply.github.com Extract common functionality of iOS platformviews into superclasses (flutter/flutter#128716)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 88be39be7b07 to aaec42812a1f (1 revision) (flutter/flutter#130787)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from b46a8baf8ed9 to 88be39be7b07 (1 revision) (flutter/flutter#130784)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 777fe158f4e7 to b46a8baf8ed9 (1 revision) (flutter/flutter#130782)
2023-07-18 tessertaha@gmail.com Fix `iconTheme` in `AppBar` doesn't apply custom `Colors.white` in the dark mode for M3 (flutter/flutter#130574)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from c6e23288db8d to 777fe158f4e7 (2 revisions) (flutter/flutter#130779)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 116eedf769be to c6e23288db8d (3 revisions) (flutter/flutter#130778)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9d018f00d687 to 116eedf769be (2 revisions) (flutter/flutter#130774)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 77ec92371846 to 9d018f00d687 (1 revision) (flutter/flutter#130772)
2023-07-18 ian@hixie.ch Document stack's clipping behaviour better (flutter/flutter#130749)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from f2958f9229a4 to 77ec92371846 (1 revision) (flutter/flutter#130769)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3cceb705007e to f2958f9229a4 (1 revision) (flutter/flutter#130767)
2023-07-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 09689d37e1d6 to 3cceb705007e (2 revisions) (flutter/flutter#130763)
2023-07-18 flar@google.com Stabilize hybrid_android_views_integration_test rendering tree (flutter/flutter#130751)
2023-07-17 andrewrkolos@gmail.com update link to good first issues (flutter/flutter#130759)
2023-07-17 31859944+LongCatIsLooong@users.noreply.github.com Prevent `InputDecorator` from supplying its descendants with non-normalized constraints (flutter/flutter#130460)
2023-07-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from 15c15fd75743 to 09689d37e1d6 (3 revisions) (flutter/flutter#130758)
2023-07-17 41930132+hellohuanlin@users.noreply.github.com [tools/ios_build_ipa] fallback to CFBundleName if CFBundleDisplayName is absent (flutter/flutter#130752)
2023-07-17 goderbauer@google.com Resolve TODOs in channels integration test (flutter/flutter#130745)
2023-07-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from ddbe23b374d8 to 15c15fd75743 (2 revisions) (flutter/flutter#130746)
...
LouiseHsu pushed a commit to LouiseHsu/flutter that referenced this pull request Jul 31, 2023
## Description

This adds some more missing example links.

I also wrote another PR for adding a check to make sure that examples are all linked from a source file and have tests: flutter#130523

## Related Issues
 - flutter#129956

## Tests
 - Documentation and refactoring only.
LouiseHsu pushed a commit to LouiseHsu/flutter that referenced this pull request Jul 31, 2023
…r#130523)

## Description

This adds a checker that will check all of the API docs examples to make sure that they are linked from at least one source file in the packages.

It also checks to make sure that all of the examples have an associated test. Since there are a large number that don't have tests at the moment, there is also a large exception list that can be burned down (burn down list is in flutter#130459).

Because there are missing links currently, this PR will only pass after flutter#130521 is merged.

## Related Issues

- flutter#129956
- flutter#130459

## Tests

- Added test for the checker.
fluttermirroringbot pushed a commit that referenced this pull request Sep 8, 2023
fixes [`Drawer` examples are misssing `dartpad` tag]( #134217)

these examples were updated in #130523
github-merge-queue bot pushed a commit that referenced this pull request Dec 30, 2025
This PR adds a lint rule to catch imports between Material, Cupertino,
and Widgets in tests. Spun out of
#177029 and the [Decoupling Tests
design
doc](https://docs.google.com/document/d/1UHxALQqCbmgjnM1RNV9xE2pK3IGyx-UktGX1D7hYCjs/edit?pli=1&tab=t.0).

For now, Material will be the place to put tests that need to import
both Material and Cupertino. See
#178693 (comment).

I used #130523 as a reference to
create this PR.

---------

Co-authored-by: Loïc Sharma <737941+loic-sharma@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants