Repository navigation
Commit d39275d
authored
Make
This PR consists of two parts of changes.
## Migrate some `@tool` directives
As part of flutter#189629, this PR
migrates specific templates used by the `material_ui` and `cupertino_ui`
packages from `{@tool}` directives to standard dartdoc to ensure they
render correctly within these packages. This migration is limited to
only these essential `{@tool}` instances, as Dartdoc does not currently
provide native support for Dartpad.
Note that Dartpad notices ("_To see it in action, copy and run this code
snippet on Dartpad_") are expanded, unlike in
flutter/packages#12120 where they're macros.
This is necessary because Dartdoc can't correctly handle nested
templates and macros, preventing inner macros from expanding correctly.
This PR will be followed by reverting
flutter/packages#12271, which constitutes the
final step of flutter#189629. I have
verified that the package docs will render correctly after the revert.
## Make `check_code_samples.dart` support the standard example
directives
Since the examples now consist of two styles, the legacy style "See code
in" and the standard style `@example`,
`check_code_samples.dart` needs to be updated to recognize the standard
`@example` directives so that it won't incorrectly report that these
examples files are not used by any docs.
## Pre-launch Checklist
- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.
If you need help, consider asking for advice on the #hackers-new channel
on [Discord].
If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.
**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.mdcheck_code_samples.dart support the standard example directives, and migrate some @tool directives (flutter#189670)1 parent b4058f9 commit d39275d
15 files changed
Lines changed: 326 additions & 137 deletions
File tree
- dev/bots
- test
- packages/flutter
- examples/api/lib
- rendering/growth_direction
- widgets
- autocomplete
- editable_text
- scrollbar
- lib/src/widgets
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
134 | 134 | | |
135 | 135 | | |
136 | 136 | | |
137 | | - | |
138 | | - | |
| 137 | + | |
| 138 | + | |
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
| |||
145 | 145 | | |
146 | 146 | | |
147 | 147 | | |
148 | | - | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
149 | 155 | | |
150 | | - | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
151 | 161 | | |
152 | 162 | | |
153 | 163 | | |
154 | 164 | | |
155 | | - | |
| 165 | + | |
| 166 | + | |
156 | 167 | | |
157 | 168 | | |
158 | 169 | | |
| |||
165 | 176 | | |
166 | 177 | | |
167 | 178 | | |
168 | | - | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
169 | 183 | | |
170 | 184 | | |
171 | 185 | | |
| |||
188 | 202 | | |
189 | 203 | | |
190 | 204 | | |
191 | | - | |
| 205 | + | |
192 | 206 | | |
193 | 207 | | |
194 | 208 | | |
195 | | - | |
| 209 | + | |
196 | 210 | | |
197 | 211 | | |
198 | 212 | | |
199 | 213 | | |
200 | | - | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
201 | 229 | | |
202 | 230 | | |
203 | 231 | | |
| |||
233 | 261 | | |
234 | 262 | | |
235 | 263 | | |
236 | | - | |
| 264 | + | |
237 | 265 | | |
238 | 266 | | |
239 | | - | |
240 | | - | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
241 | 271 | | |
242 | | - | |
243 | | - | |
244 | | - | |
245 | | - | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
246 | 276 | | |
247 | 277 | | |
| 278 | + | |
248 | 279 | | |
249 | 280 | | |
250 | 281 | | |
251 | 282 | | |
252 | 283 | | |
253 | 284 | | |
254 | | - | |
255 | | - | |
256 | | - | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
257 | 291 | | |
258 | | - | |
| 292 | + | |
| 293 | + | |
259 | 294 | | |
260 | | - | |
261 | | - | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
262 | 304 | | |
263 | 305 | | |
264 | 306 | | |
265 | | - | |
| 307 | + | |
266 | 308 | | |
267 | 309 | | |
268 | 310 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
121 | 121 | | |
122 | 122 | | |
123 | 123 | | |
124 | | - | |
| 124 | + | |
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
| |||
0 commit comments