-
Notifications
You must be signed in to change notification settings - Fork 27.1k
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.
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
Update doc-import to primary configured import, _goldens_io.dart #151390
Conversation
There is a... restriction in dartdoc, such that a library which is `@docImport`ed in one library, must be otherwise regularly imported in some other library. Without this case, dartdoc gets a bit lost about where the doc-imported library is. Combine this restriction with analyzer's restriction that it doesn't super duper handle configuration imports. Since `_goldens_io.dart` is the "primary" import in all other files, and `_goldens_web.dart` is the "configured" import, we must only doc-import `_goldens_io.dart`.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Will there be some kind of a machinery (lint, etc) in place to warn against these "incorrect" imports? |
Dartdoc will fail, as it is doing in dartdoc's CI at present :D |
Other than that, no planned mechanisms. I don't think we can add a performant lint rule, as the issue is how sensitive dartdoc is to these things... maybe there is a specific bug in analyzer's handling of configurable imports that we can fix. |
…tter#151390) There is a... restriction in dartdoc, such that a library which is `@docImport`ed in one library, must be otherwise regularly imported in some other library. Without this case, dartdoc gets a bit lost about where the doc-imported library is. Combine this restriction with analyzer's restriction that it doesn't super duper handle configuration imports. Since `_goldens_io.dart` is the "primary" import in all other files, and `_goldens_web.dart` is the "configured" import, we must only doc-import `_goldens_io.dart`.
flutter/flutter@fafd67d...5103d75 2024-07-09 andrewrkolos@gmail.com [tool] Remove some usages of deprecated usage package (flutter/flutter#151359) 2024-07-09 43759233+kenzieschmoll@users.noreply.github.com Write the package config location to the test bootstrap. (flutter/flutter#150440) 2024-07-09 dacoharkes@google.com [deps] Roll dart-lang/native packages (flutter/flutter#151403) 2024-07-08 andrewrkolos@gmail.com [tool] make `testUsingContext` provide a `Stdio` (with `hasTerminal` unset) override by default (flutter/flutter#151357) 2024-07-08 120297255+PurplePolyhedron@users.noreply.github.com Make `FittedBox` not throw when child has zero size. (flutter/flutter#150430) 2024-07-08 nate.w5687@gmail.com Update `DataTable` documentation (flutter/flutter#151356) 2024-07-08 nate.w5687@gmail.com `MaterialState` � `WidgetState` in documentation (flutter/flutter#151376) 2024-07-08 41930132+hellohuanlin@users.noreply.github.com [ios]A typical news app benchmark with bottom ad banner (flutter/flutter#150991) 2024-07-08 gspencergoog@users.noreply.github.com Re-enable `SemanticsAction.focus` matchers (flutter/flutter#150990) 2024-07-08 hans.muller@gmail.com Added SliverFloatingHeader.snapMode (flutter/flutter#151289) 2024-07-08 nate.w5687@gmail.com Factor out deprecated names in example code (flutter/flutter#151374) 2024-07-08 cedvandenbosch@gmail.com Add cedric vanden bosch to authors (flutter/flutter#151313) 2024-07-08 engine-flutter-autoroll@skia.org Roll Packages from 97bad7e to 14341d1 (5 revisions) (flutter/flutter#151417) 2024-07-08 srawlins@google.com Update doc-import to primary configured import, _goldens_io.dart (flutter/flutter#151390) 2024-07-08 tessertaha@gmail.com [Reland] - Enable `explicitChildNodes` for the `AlertDialog` content (flutter/flutter#149597) 2024-07-08 32538273+ValentinVignal@users.noreply.github.com Add tests for material_state_border_side.0_test.dart (flutter/flutter#151089) 2024-07-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from ca79a56a66d7 to 69075e7e87d4 (1 revision) (flutter/flutter#151393) 2024-07-08 32538273+ValentinVignal@users.noreply.github.com Add tests for action_listener.0.dart (flutter/flutter#150606) 2024-07-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from 5ca3b856ee5a to ca79a56a66d7 (1 revision) (flutter/flutter#151387) 2024-07-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3600ec613a00 to 5ca3b856ee5a (1 revision) (flutter/flutter#151378) 2024-07-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from d1ebc5fde630 to 3600ec613a00 (1 revision) (flutter/flutter#151377) 2024-07-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from e6b09697df1a to d1ebc5fde630 (1 revision) (flutter/flutter#151362) 2024-07-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.3 to 4.3.4 (flutter/flutter#151354) 2024-07-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4ee09d3b7f3b to e6b09697df1a (2 revisions) (flutter/flutter#151352) 2024-07-05 sokolovskyi.konstantin@gmail.com Add tests for color_filtered.0.dart example. (flutter/flutter#151064) 2024-07-05 christopherfujino@gmail.com de-duplicate code in analyze.dart (flutter/flutter#151279) 2024-07-05 engine-flutter-autoroll@skia.org Roll Packages from 754de19 to 97bad7e (1 revision) (flutter/flutter#151350) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC dit@google.com,rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
There is a... restriction in dartdoc, such that a library which is
@docImport
ed in one library, must be otherwise regularly imported in some other library. Without this case, dartdoc gets a bit lost about where the doc-imported library is.Combine this restriction with analyzer's restriction that it doesn't super duper handle configuration imports. Since
_goldens_io.dart
is the "primary" import in all other files, and_goldens_web.dart
is the "configured" import, we must only doc-import_goldens_io.dart
.