Skip to content

[css_colors] Adopt code excerpts in README #5478

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 6 commits into from
Dec 13, 2023
Merged

[css_colors] Adopt code excerpts in README #5478

merged 6 commits into from
Dec 13, 2023

Conversation

mike-v2
Copy link
Contributor

@mike-v2 mike-v2 commented Nov 26, 2023

Updates the README to use a compiled excerpt source for its example of importing and using CSSColors.

Part of flutter/flutter#102679

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • 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.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

tarrinneal
tarrinneal approved these changes Nov 28, 2023
View reviewed changes
Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

lgtm with a nit. @stuartmorgan for second review.

packages/css_colors/CHANGELOG.md Outdated

* Updates minimum supported SDK version to Flutter 3.10/Dart 3.0.
* Updates README to improve example of using `CSSColors`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Improves README example and updates it to use code excerpts.

stuartmorgan-g
stuartmorgan-g requested changes Nov 29, 2023
View reviewed changes
packages/css_colors/example/lib/readme_excerpts.dart Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be really easy for us to get this from an actual example main.dart rather than having to maintain a second file. I think it'll also be pretty confusing to have the example directory and pubspec and such, but not actually have an example to run.

Given that, I think we should either wait for #5512, or fold creating an actual example into this PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Alternately, we could do this with test/, since looking at the other PR I'm not sure we actually want an example.

stuartmorgan-g
stuartmorgan-g approved these changes Dec 12, 2023
View reviewed changes
Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

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

LGTM with nit, thanks!

packages/css_colors/README.md Outdated
@@ -8,13 +8,15 @@ from `dart:ui`, which means they're useful for Flutter apps.
Import
Copy link
Contributor

Choose a reason for hiding this comment

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

The entire "Import" section, including the excerpt, can be removed; the installation tab on pub.dev has that information now, so we are removing it from READMEs.

packages/css_colors/test/css_colors_test.dart Outdated
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// #docregion Import
Copy link
Contributor

Choose a reason for hiding this comment

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

And then these can be removed as well.

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 13, 2023
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Dec 13, 2023
@auto-submit Auto-submit
Copy link
Contributor

auto-submit bot commented Dec 13, 2023

auto label is removed for flutter/packages/5478, due to - The status or check suite Linux_android android_device_tests_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 13, 2023
@auto-submit auto-submit bot merged commit a0fadd0 into flutter:main Dec 13, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 14, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 14, 2023
@engine-flutter-autoroll
a0fadd0 [css_colors] Adopt code excerpts in README (flutter/packages#…
5086b3e 
…5478)
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Dec 14, 2023
@engine-flutter-autoroll
Roll Packages from b5958e2 to 1151191 (10 revisions) (#140154)
3a20f9c 
flutter/packages@b5958e2...1151191

2023-12-14 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 2.22.8 to 3.22.11 (flutter/packages#5674)
2023-12-13 ditman@gmail.com [ci][web] Ignore always_specify_types for JSArray. (flutter/packages#5669)
2023-12-13 mikemcguiness@protonmail.com [tool] Add support for `.java`, `.gradle`, `.sh`, and `.m` files� (flutter/packages#5567)
2023-12-13 ditman@gmail.com [google_sign_in] Update (web) example app. (flutter/packages#5634)
2023-12-13 34871572+gmackall@users.noreply.github.com [path_provider] De-flake getExternalStorageDirectories test (flutter/packages#5628)
2023-12-13 ditman@gmail.com [google_sign_in_web] Stop relying on framework internals. (flutter/packages#5660)
2023-12-13 43054281+camsim99@users.noreply.github.com [Android] Bump Gradle version to 7.6.3 (flutter/packages#5522)
2023-12-13 mikemcguiness@protonmail.com [google_sign_in] Adopt code excerpts in README (flutter/packages#5521)
2023-12-13 mikemcguiness@protonmail.com [css_colors] Adopt code excerpts in README (flutter/packages#5478)
2023-12-13 JeroenWeener@users.noreply.github.com [webview_flutter] Support for handling basic authentication requests (Android) (flutter/packages#5454)

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-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: 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
@mike-v2 mike-v2 mentioned this pull request Dec 20, 2023
Closed
11 tasks
@reidbaker reidbaker mentioned this pull request Jan 12, 2024
Closed
@reidbaker reidbaker mentioned this pull request Jan 19, 2024
Merged
12 tasks
@reidbaker reidbaker mentioned this pull request Feb 19, 2024
Merged
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartmorgan-g stuartmorgan-g stuartmorgan-g approved these changes

@tarrinneal tarrinneal tarrinneal approved these changes

Assignees
No one assigned
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: css_colors
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mike-v2 @stuartmorgan-g @tarrinneal