Skip to content

feat!: rename Items to Values (#12)#21

Merged
millerjp merged 1 commit into
mainfrom
feat/rename-items-to-values
Apr 20, 2026
Merged

feat!: rename Items to Values (#12)#21
millerjp merged 1 commit into
mainfrom
feat/rename-items-to-values

Conversation

@millerjp

Copy link
Copy Markdown

Summary

Renames SyncMap.Items() []V to SyncMap.Values() []V to match Go convention (maps.Values in stdlib 1.23). Pre-v1.0 breaking change; zero known importers under the axonops module path; no deprecation shim.

Closes #12.

Diff

  • syncmap.go — method rename + godoc first line + internal local var.
  • doc.go — package overview now lists Keys, and Values instead of Keys, and Items.
  • syncmap_test.goTestItemsTestValues; local vars renamed; subtest names and assertions unchanged.

Verification

$ git grep -nE '\bItems\b' -- . ':!docs/' ':!.issue-drafts/'
(none)

$ go doc github.com/axonops/syncmap Values | head -5
func (m *SyncMap[K, V]) Values() []V
    Values returns a slice of all values present in the map at the moment of the
    call. It runs in O(n) time.

$ go doc github.com/axonops/syncmap Items
doc: no symbol Items in package …

$ make check
… (14 gates green, coverage 100%, no vulnerabilities)

Agent gates

  • Plan: single-commit scope, two source files + test.
  • code-reviewer: caught a missed reference in doc.go:30 ("Keys, and Items"); fixed in the same commit.
  • security-reviewer: skipped — no concurrency or type-assertion semantics touched (rename only).
  • performance-reviewer: skipped — identical machine code, no benchmark delta possible.
  • go-quality: 14/14 green (confirmed via make check).
  • commit-message-reviewer: PASS.

Out of scope

Test plan

  • CI green end-to-end
  • pkg.go.dev search for importers of github.com/axonops/syncmap confirms zero importers (no breakage in the wild)

Rename SyncMap.Items() to SyncMap.Values() to match Go convention
(maps.Values in stdlib 1.23). Pre-v1.0 under the new axonops module
path with no known importers, so no deprecation shim.

Touches: syncmap.go (method + godoc first line + local var), doc.go
(package overview mentions Values instead of Items), syncmap_test.go
(TestValues replaces TestItems; subtest names and assertions
unchanged). No behaviour change; coverage remains 100%.

CHANGELOG entry for this breaking rename is deferred to #17, which
owns CHANGELOG.md.
@millerjp millerjp merged commit 3e8bbd8 into main Apr 20, 2026
13 checks passed
@millerjp millerjp deleted the feat/rename-items-to-values branch April 20, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat!: rename Items to Values

1 participant