Skip to content

Check sample links for malformed links #137807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 6, 2023
Merged

Check sample links for malformed links #137807

merged 2 commits into from
Nov 6, 2023

Conversation

gspencergoog
Copy link
Contributor

@gspencergoog gspencergoog commented Nov 2, 2023 •
edited
Loading

Description

This checks API doc strings for malformed links to examples. It prevents errors in capitalization, spacing, number of asterisks, etc. It won't catch all errors, because it needs to have a minimally indicative string to know that it even is trying to be a link to an example. At a minimum, the line needs to look like (literally, not as a regexp) ///*seecode.* in order to be seen as a link to an example.

Separately, I'm going to add a check to the snippets tool that checks to make sure that an {@tool} block includes either a link to a sample file or a dart code block.

Tests

  • Added a test to make sure it catches some malformed links.

goderbauer
goderbauer approved these changes Nov 2, 2023
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

dev/bots/check_code_samples.dart Outdated
Copy link
Member

Choose a reason for hiding this comment

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

In the pubspec we should move this to be an explicit dependency, not just a dependency of a dependency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's actually unused (added by the IDE), so I removed it.

@gspencergoog gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 2, 2023
@auto-submit Auto-submit
Copy link
Contributor

auto-submit bot commented Nov 2, 2023

auto label is removed for flutter/flutter/137807, due to - The status or check suite Windows framework_tests_misc has failed. Please fix the issues identified (or deflake) before re-applying this label.

@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 2, 2023
@gspencergoog gspencergoog added autosubmit Merge PR when tree becomes green via auto submit App d: api docs Issues with https://api.flutter.dev/ labels Nov 6, 2023
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 6, 2023
@auto-submit Auto-submit
Copy link
Contributor

auto-submit bot commented Nov 6, 2023

auto label is removed for flutter/flutter/137807, due to - The status or check suite Windows framework_tests_misc has failed. Please fix the issues identified (or deflake) before re-applying this label.

@gspencergoog gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 6, 2023
@auto-submit auto-submit bot merged commit f5a9835 into flutter:master Nov 6, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Nov 6, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 6, 2023
@engine-flutter-autoroll
f5a9835 Check sample links for malformed links (flutter/flutter#137807)
f9008d7
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Nov 6, 2023
@engine-flutter-autoroll
Roll Flutter from 29b2516 to f5a9835 (101 revisions) (#5341)
be18d28 
Roll Flutter from 29b2516 to f5a9835 (101 revisions)

flutter/flutter@29b2516...f5a9835

2023-11-06 gspencergoog@users.noreply.github.com Check sample links for malformed links (flutter/flutter#137807)
2023-11-06 iinozemtsev@google.com Change cast in json parsing (flutter/flutter#137708)
2023-11-06 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Update BottomNavigationBar tests for M3" (flutter/flutter#137948)
2023-11-06 engine-flutter-autoroll@skia.org Roll Packages from cccf5d2 to 49eac1f (2 revisions) (flutter/flutter#137943)
2023-11-06 leroux_bruno@yahoo.fr Update BottomNavigationBar tests for M3 (flutter/flutter#136624)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4f6ed31bd8bd to bdfa8aa8f81f (1 revision) (flutter/flutter#137941)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from b9b3269b0b2c to 4f6ed31bd8bd (2 revisions) (flutter/flutter#137935)
2023-11-06 tessertaha@gmail.com Provide a helpful error message when `ColorScheme.brightness` doesn't match `ThemeData.brightness` (flutter/flutter#137611)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 555ffa17b55c to b9b3269b0b2c (1 revision) (flutter/flutter#137933)
2023-11-06 andrewrkolos@gmail.com Fix tool exit message shown when user provides a non-list to "assets" for a deferred component (flutter/flutter#137837)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0d8c7ceacc01 to 555ffa17b55c (1 revision) (flutter/flutter#137921)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 11d66db97d3f to 0d8c7ceacc01 (1 revision) (flutter/flutter#137920)
2023-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from a7592e42464c to 11d66db97d3f (1 revision) (flutter/flutter#137914)
2023-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1c6bd97e2288 to a7592e42464c (1 revision) (flutter/flutter#137912)
2023-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from daf18fe46b72 to 1c6bd97e2288 (1 revision) (flutter/flutter#137908)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from a45e679828e6 to daf18fe46b72 (1 revision) (flutter/flutter#137904)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from fb2a9c20141e to a45e679828e6 (1 revision) (flutter/flutter#137903)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 576833873c15 to fb2a9c20141e (1 revision) (flutter/flutter#137900)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 25f5e285f874 to 576833873c15 (1 revision) (flutter/flutter#137898)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7282a5d94ab6 to 25f5e285f874 (2 revisions) (flutter/flutter#137892)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from b66a87626300 to 7282a5d94ab6 (2 revisions) (flutter/flutter#137887)
2023-11-04 sokolovskyi.konstantin@gmail.com HeroController should dispatch creation and disposal events. (flutter/flutter#137835)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from ec20731de6ff to b66a87626300 (1 revision) (flutter/flutter#137877)
2023-11-03 thesonerik@gmail.com InheritedElement.removeDependent() (flutter/flutter#129210)
2023-11-03 goderbauer@google.com Remove unused generic type from BottomSheet (flutter/flutter#137791)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 035740c1f90e to ec20731de6ff (2 revisions) (flutter/flutter#137872)
2023-11-03 dacoharkes@google.com Pin dart-lang/native dependencies (flutter/flutter#137601)
2023-11-03 chris@bracken.jp Send caret rect to embedder on selection update (flutter/flutter#137863)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 677040f10f65 to 035740c1f90e (4 revisions) (flutter/flutter#137871)
2023-11-03 cbobbe@zulip.com Tooltip docs: Recommend setting preferBelow to false in theme (flutter/flutter#135879)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from f363a6e5e093 to 677040f10f65 (2 revisions) (flutter/flutter#137861)
2023-11-03 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Android] Support Android 34" (flutter/flutter#137865)
2023-11-03 sokolovskyi.konstantin@gmail.com InkFeature should dispatch creation and disposal events. (flutter/flutter#137793)
2023-11-03 sokolovskyi.konstantin@gmail.com AppLifecycleListener should dispatch creation and disposal events. (flutter/flutter#137840)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from d5ccb5b1b706 to f363a6e5e093 (2 revisions) (flutter/flutter#137858)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 72262a238090 to d5ccb5b1b706 (3 revisions) (flutter/flutter#137857)
2023-11-03 hans.muller@gmail.com Updated the nested navigation NavigationBar example (flutter/flutter#137788)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0415a4f5e2a2 to 72262a238090 (2 revisions) (flutter/flutter#137853)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8531c5935356 to 0415a4f5e2a2 (1 revision) (flutter/flutter#137847)
2023-11-03 jonahwilliams@google.com Roll flutter gallery version forward. (flutter/flutter#137846)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 43653c5a3ec8 to 8531c5935356 (1 revision) (flutter/flutter#137845)
2023-11-03 engine-flutter-autoroll@skia.org Roll Packages from 33c2b4e to cccf5d2 (6 revisions) (flutter/flutter#137841)
2023-11-03 matej.knopp@gmail.com [web] dispatch corresponding keyup events in text editing integrations (flutter/flutter#136874)
2023-11-03 41873024+droidbg@users.noreply.github.com [leak-tracking] Add more leak tracking in test/painting #3 (flutter/flutter#136170)
2023-11-03 polinach@google.com Upgrade leak_tracker and remove some deps in allow list. (flutter/flutter#137806)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from fc7c3f70c076 to 43653c5a3ec8 (1 revision) (flutter/flutter#137827)
...
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 16, 2024
@engine-flutter-autoroll
f5a9835 Check sample links for malformed links (flutter/flutter#137807)
1757eb8
dko5ki23t pushed a commit to dko5ki23t/google_maps_flutter_improved that referenced this pull request May 24, 2025
@engine-flutter-autoroll
Roll Flutter from 29b25165cab8 to f5a983535131 (101 revisions) (#5341)
186c4e0 
Roll Flutter from 29b25165cab8 to f5a983535131 (101 revisions)

flutter/flutter@29b2516...f5a9835

2023-11-06 gspencergoog@users.noreply.github.com Check sample links for malformed links (flutter/flutter#137807)
2023-11-06 iinozemtsev@google.com Change cast in json parsing (flutter/flutter#137708)
2023-11-06 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Update BottomNavigationBar tests for M3" (flutter/flutter#137948)
2023-11-06 engine-flutter-autoroll@skia.org Roll Packages from cccf5d24d703 to 49eac1fec6c7 (2 revisions) (flutter/flutter#137943)
2023-11-06 leroux_bruno@yahoo.fr Update BottomNavigationBar tests for M3 (flutter/flutter#136624)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4f6ed31bd8bd to bdfa8aa8f81f (1 revision) (flutter/flutter#137941)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from b9b3269b0b2c to 4f6ed31bd8bd (2 revisions) (flutter/flutter#137935)
2023-11-06 tessertaha@gmail.com Provide a helpful error message when `ColorScheme.brightness` doesn't match `ThemeData.brightness` (flutter/flutter#137611)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 555ffa17b55c to b9b3269b0b2c (1 revision) (flutter/flutter#137933)
2023-11-06 andrewrkolos@gmail.com Fix tool exit message shown when user provides a non-list to "assets" for a deferred component (flutter/flutter#137837)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0d8c7ceacc01 to 555ffa17b55c (1 revision) (flutter/flutter#137921)
2023-11-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 11d66db97d3f to 0d8c7ceacc01 (1 revision) (flutter/flutter#137920)
2023-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from a7592e42464c to 11d66db97d3f (1 revision) (flutter/flutter#137914)
2023-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1c6bd97e2288 to a7592e42464c (1 revision) (flutter/flutter#137912)
2023-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from daf18fe46b72 to 1c6bd97e2288 (1 revision) (flutter/flutter#137908)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from a45e679828e6 to daf18fe46b72 (1 revision) (flutter/flutter#137904)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from fb2a9c20141e to a45e679828e6 (1 revision) (flutter/flutter#137903)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 576833873c15 to fb2a9c20141e (1 revision) (flutter/flutter#137900)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 25f5e285f874 to 576833873c15 (1 revision) (flutter/flutter#137898)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7282a5d94ab6 to 25f5e285f874 (2 revisions) (flutter/flutter#137892)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from b66a87626300 to 7282a5d94ab6 (2 revisions) (flutter/flutter#137887)
2023-11-04 sokolovskyi.konstantin@gmail.com HeroController should dispatch creation and disposal events. (flutter/flutter#137835)
2023-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from ec20731de6ff to b66a87626300 (1 revision) (flutter/flutter#137877)
2023-11-03 thesonerik@gmail.com InheritedElement.removeDependent() (flutter/flutter#129210)
2023-11-03 goderbauer@google.com Remove unused generic type from BottomSheet (flutter/flutter#137791)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 035740c1f90e to ec20731de6ff (2 revisions) (flutter/flutter#137872)
2023-11-03 dacoharkes@google.com Pin dart-lang/native dependencies (flutter/flutter#137601)
2023-11-03 chris@bracken.jp Send caret rect to embedder on selection update (flutter/flutter#137863)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 677040f10f65 to 035740c1f90e (4 revisions) (flutter/flutter#137871)
2023-11-03 cbobbe@zulip.com Tooltip docs: Recommend setting preferBelow to false in theme (flutter/flutter#135879)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from f363a6e5e093 to 677040f10f65 (2 revisions) (flutter/flutter#137861)
2023-11-03 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Android] Support Android 34" (flutter/flutter#137865)
2023-11-03 sokolovskyi.konstantin@gmail.com InkFeature should dispatch creation and disposal events. (flutter/flutter#137793)
2023-11-03 sokolovskyi.konstantin@gmail.com AppLifecycleListener should dispatch creation and disposal events. (flutter/flutter#137840)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from d5ccb5b1b706 to f363a6e5e093 (2 revisions) (flutter/flutter#137858)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 72262a238090 to d5ccb5b1b706 (3 revisions) (flutter/flutter#137857)
2023-11-03 hans.muller@gmail.com Updated the nested navigation NavigationBar example (flutter/flutter#137788)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0415a4f5e2a2 to 72262a238090 (2 revisions) (flutter/flutter#137853)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8531c5935356 to 0415a4f5e2a2 (1 revision) (flutter/flutter#137847)
2023-11-03 jonahwilliams@google.com Roll flutter gallery version forward. (flutter/flutter#137846)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from 43653c5a3ec8 to 8531c5935356 (1 revision) (flutter/flutter#137845)
2023-11-03 engine-flutter-autoroll@skia.org Roll Packages from 33c2b4e53ad7 to cccf5d24d703 (6 revisions) (flutter/flutter#137841)
2023-11-03 matej.knopp@gmail.com [web] dispatch corresponding keyup events in text editing integrations (flutter/flutter#136874)
2023-11-03 41873024+droidbg@users.noreply.github.com [leak-tracking] Add more leak tracking in test/painting #3 (flutter/flutter#136170)
2023-11-03 polinach@google.com Upgrade leak_tracker and remove some deps in allow list. (flutter/flutter#137806)
2023-11-03 engine-flutter-autoroll@skia.org Roll Flutter Engine from fc7c3f70c076 to 43653c5a3ec8 (1 revision) (flutter/flutter#137827)
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@goderbauer goderbauer goderbauer approved these changes

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App d: api docs Issues with https://api.flutter.dev/

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@gspencergoog @goderbauer