Skip to content

Conversation

dcharkes
Copy link
Collaborator

@dcharkes dcharkes commented Oct 9, 2025

This revamps the READMEs to include

  1. code snippets with links to the examples, and
  2. links to https://dart.dev/tools/hooks.

Side note, I'm thinking we might want to completely remove the examples from package:hooks and simply link to the examples in package:code_assets. The examples in package:hooks are rather artificial and more of a feature showcase, which makes them less understandable.

Bug:

Copy link

github-actions bot commented Oct 9, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
code_assets None 0.19.7 0.19.7 0.19.7 ✔️
hooks None 0.20.2 0.20.2 0.20.2 ✔️

This check can be disabled by tagging the PR with skip-breaking-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbol Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/objective_c/lib/src/ns_input_stream.dart

This check can be disabled by tagging the PR with skip-license-check.

@coveralls
Copy link

coveralls commented Oct 9, 2025

Coverage Status

coverage: 81.228%. remained the same
when pulling a0b2a01 on docs-hooks
into 33a33b2 on main.

@dcharkes dcharkes mentioned this pull request Oct 9, 2025
4 tasks
Copy link
Contributor

@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.

This is a nice improvement to the readme to make the packages more approachable! 🚀

LGTM

@goderbauer
Copy link
Contributor

Side note, I'm thinking we might want to completely remove the examples from package:hooks and simply link to the examples in package:code_assets. The examples in package:hooks are rather artificial and more of a feature showcase, which makes them less understandable.

I think it is a good idea to link to the code_asset examples from the hooks readme, as you have done in this PR. I would keep the examples in the source tree, though. They are still useful to demonstrate individual features. I would add a link from hooks/examples/README.md to the more comprehensive examples in code_assets, though.

@auto-submit auto-submit bot merged commit c76ea57 into main Oct 9, 2025
28 checks passed
@auto-submit auto-submit bot deleted the docs-hooks branch October 9, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants