Skip to content

docs: name the owning package in doc comments that still said sdk. - #477

Merged
bomly-guy merged 1 commit into
mainfrom
claude/sdk-v013-comment-cleanup
Sep 17, 2026
Merged

docs: name the owning package in doc comments that still said sdk.#477
bomly-guy merged 1 commit into
mainfrom
claude/sdk-v013-comment-cleanup

Conversation

@bomly-guy

@bomly-guy bomly-guy commented Sep 17, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Summary

A follow-up to #476. That PR requalified every sdk.X code reference to the package that owns it after the v0.13.0 split, but doc comments were not part of the rewrite. Twenty-one comments across sixteen files still describe live types as sdk.Package, sdk.Finding, sdk.HostContext, sdk.DependencyNode, sdk.SourcePosition and so on — qualifiers that resolve to nothing now, so a reader who goes looking lands on a package that no longer exists.

Each is rewritten to the package that actually owns the symbol, using the same name table that drove the code migration.

Deliberately unchanged

Two references stay exactly as written:

  • internal/auditors/package/auditor.go:389
  • internal/output/view.go:1084

Both say sdk.ParsePackageURL "was the deprecated anchore-fork entry point and is gone". That is a statement about history, and it is true as written; rewriting it would make it false.

One comment named an import rather than a type (// Ensure sdk import is used ... above var _ = model.Reachability{}) and now names model.

Verification

go build ./..., go vet ./..., gofmt -l clean, and a full golangci-lint run reports 0 issues. Comments only — no behaviour change.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Corrected internal documentation references to align with current package and type names.
    • Updated comments across CLI, detector, registry, output, composition, and interface components.
    • Clarified references to plugin, model, and host context types.

  • Bug Fixes

    • No runtime behavior or user-facing functionality changed.

@bomly-guy @claude
docs: name the owning package in doc comments that still said sdk.
0c97bac 
The v0.13.0 migration requalified code but not prose, so twenty-one doc
comments across sixteen files still described live types as sdk.Package,
sdk.Finding, sdk.HostContext and the like — qualifiers that now resolve to
nothing, sending a reader looking for the type to a package that no longer
exists.

Two references are left exactly as they are: both say sdk.ParsePackageURL
"was the deprecated anchore-fork entry point and is gone", which is a
statement about history and true as written.

Co-Authored-By: Claude Opus 5 <[email protected]>
@coderabbitai

coderabbitai Bot commented Sep 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 76ca6824-41e9-41a7-a8fc-6f92bf2f4132

📥 Commits

Reviewing files that changed from the base of the PR and between 417e8c9 and 0c97bac.

📒 Files selected for processing (16)
  • internal/cli/cmd_progress.go
  • internal/cli/opts/planning_recursive.go
  • internal/cli/render/diff.go
  • internal/composition/composition.go
  • internal/composition/composition_test.go
  • internal/detectors/attribution.go
  • internal/detectors/python/poetrylock.go
  • internal/engine/pipeline_resolve.go
  • internal/mcp/server.go
  • internal/output/sarif.go
  • internal/output/sarif_reachability_test.go
  • internal/output/types.go
  • internal/output/view_test.go
  • internal/registry/builder.go
  • internal/registry/module.go
  • internal/tui/posture.go
📝 Walkthrough

Walkthrough

The pull request updates documentation comments across CLI, composition, detector, engine, MCP, output, registry, and TUI packages. It replaces outdated sdk type references with current plugin and model references. No runtime behavior changes.

Changes

Documentation reference alignment

Layer / File(s) Summary
Plugin reference updates
internal/cli/..., internal/composition/..., internal/engine/..., internal/registry/...		 Comments now reference current plugin types, including plugin.Subproject, plugin.HostContext, and plugin.DetectorWarning.
Model reference updates
internal/cli/render/..., internal/detectors/..., internal/tui/...		 Comments now reference current model types, including model.Reachability, model.RelationshipForPath, and model.PackageScorecard.
Output documentation updates
internal/mcp/..., internal/output/...		 Output and test-helper comments now reference current model types such as model.Finding, model.Package, and model.PackageRegistry.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/sdk-v013-comment-cleanup

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Bomly Diff Summary

Compared 417e8c913c4d04f3a7a4edc3d88a41fdb0e540fd to 0c97bacaaf869a86e1226df144ac3f651f1d43bb.

Overview

Status Manifests Dependencies Findings Duration
✅ Pass +0 / ~0 / -0 0 added / 0 version changed / 0 detail changes / 0 removed 0 introduced / 0 persisted / 0 resolved 1m 14s

Dependency Changes

✅ No dependency changes.

Vulnerabilities

✅ No vulnerability changes.

License Changes

✅ No license changes.

Project Posture

✅ No project posture changes (--matchers +scorecard was not selected).

Policy Findings

✅ No policy differences were identified.

@bomly-guy
bomly-guy enabled auto-merge (squash) September 17, 2026 07:12
@bomly-guy
bomly-guy disabled auto-merge September 17, 2026 07:12
@bomly-guy
bomly-guy merged commit 46f8b75 into main Sep 17, 2026
15 of 16 checks passed
@bomly-guy
bomly-guy deleted the claude/sdk-v013-comment-cleanup branch September 17, 2026 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@bomly-guy