docs: v0.4.0 README/AGENTS refresh + generic type-param header#15
Merged
Conversation
… the diff
- Update the README diff examples to the v0.4.0 output (type <Name> struct { +
"(NN.NN% smaller)"), document the four new flags in Usage, add a "Scanning
scope" section (generated/tests/exclude/skip-cache-padded), and note the
generic-type behavior (diff uses assumed sizes; inspect skips generics).
- Refresh AGENTS.md: internal/structfilter, common.Options scan knobs, and the
Finding presentation fields.
- Render generic type-parameter names in the diff header, e.g.
"type Generic[T] struct {": capture Finding.TypeParams in align (from the
named type's TypeParams) and prepend them in ui.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #15 +/- ##
==========================================
+ Coverage 82.66% 83.21% +0.55%
==========================================
Files 10 10
Lines 548 566 +18
==========================================
+ Hits 453 471 +18
Misses 55 55
Partials 40 40 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Exercise the defensive early-returns (empty name, name not in scope, alias to a non-Named type) plus single/multiple type parameters, bringing typeParamNames to 100% coverage. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release-prep for v0.4.0: bring the docs in line with the new behavior, and a small
fix so generic structs render with their type parameters.
Docs
type <Name> struct {and the(NN.NN% smaller)suffix (unified + side-by-side + quick-start).-exclude,-generated,-tests,-skip-cache-padded) plus-version._test.goareskipped by default;
-skip-cache-paddedreferenced from the false-sharing caveat.skips generics).
common.Options, Finding presentation fields).Small feature
Render generic type-parameter names in the diff header —
type Generic[T] struct {instead of
type Generic struct {.aligncapturesFinding.TypeParams("[T]","[K, V]") from the named type;uiprepends them. Non-generic output unchanged.task cigreen; coverage 82.8%.