Skip to content

[record_use] Use update_snippets.dart#3087

Merged
auto-submit[bot] merged 1 commit intomainfrom
record-use-snippets
Feb 12, 2026
Merged

[record_use] Use update_snippets.dart#3087
auto-submit[bot] merged 1 commit intomainfrom
record-use-snippets

Conversation

@dcharkes
Copy link
Collaborator

Fix the doc comments in this package.

  • Fixes the docs to be up to date with current usage.
    • Adds a pirate themed API doc.
  • Ignores the use cases for now.
    • In the future we should make these full fledged examples in the examples/ dir.
  • Makes the snippets tool more powerful with anchors and nested snippets.

@github-actions
Copy link

github-actions bot commented Feb 12, 2026

PR Health

License Headers ✔️
// Copyright (c) 2026, 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/hooks_runner/test_data/download_assets/hook/build.dart
pkgs/jni/test/debug_release_test.dart
pkgs/objective_c/example/command_line/lib/main.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

This check can be disabled by tagging the PR with skip-license-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.

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
hooks None 1.0.1 1.0.1 1.0.1 ✔️
record_use Breaking 0.4.2 0.5.0-wip 0.5.0-wip ✔️

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

@coveralls
Copy link

coveralls commented Feb 12, 2026

Coverage Status

coverage: 74.172%. remained the same
when pulling 81a0989 on record-use-snippets
into 73ba13f on main.

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.

LGTM

- Add `pkgs/record_use` to `update_snippets.dart`.
- Support multiple snippets per file using `#anchor` in `update_snippets.dart`.
- Strip snippet markers from extracted snippets in `update_snippets.dart`.
- Implement dedenting in `update_snippets.dart` to fix snippet indentation.
- Add `pkgs/record_use/example/api/usage.dart` and `usage_link.dart` with source for snippets.
- Update `record_use` documentation to use snippets with pirate-themed examples.
- Use abstract classes and static methods for recording examples (instance calls not supported).
- Ensure all `@RecordUse()` annotations use parentheses.
- Add `<!-- no-source-file -->` to conceptual docs in `record_use`.
- Fix inaccurate documentation regarding annotations and doubles.
- Simplify API doc comments with direct usage examples and intent-signaling comments.
- Remove outdated `Limitations` section from `README.md`.
@dcharkes dcharkes force-pushed the record-use-snippets branch from d1008a4 to 81a0989 Compare February 12, 2026 11:20
@auto-submit auto-submit bot merged commit 91d34c6 into main Feb 12, 2026
22 checks passed
@auto-submit auto-submit bot deleted the record-use-snippets branch February 12, 2026 11:35
Hassnaa9 pushed a commit to Hassnaa9/native that referenced this pull request Feb 13, 2026
Fix the doc comments in this package.

* Fixes the docs to be up to date with current usage.
  * Adds a pirate themed API doc.
* Ignores the use cases for now.
  * In the future we should make these full fledged examples in the examples/ dir.
* Makes the snippets tool more powerful with anchors and nested snippets.
Cairo09 pushed a commit to Cairo09/native that referenced this pull request Feb 13, 2026
Fix the doc comments in this package.

* Fixes the docs to be up to date with current usage.
  * Adds a pirate themed API doc.
* Ignores the use cases for now.
  * In the future we should make these full fledged examples in the examples/ dir.
* Makes the snippets tool more powerful with anchors and nested snippets.
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