Skip to content

docs(bind): require strictly comparable bound types - #257

Merged
linkdata merged 2 commits into
mainfrom
docs/246-strictly-comparable-binder
Aug 7, 2026
Merged

docs(bind): require strictly comparable bound types#257
linkdata merged 2 commits into
mainfrom
docs/246-strictly-comparable-binder

Conversation

@linkdata

@linkdata linkdata commented Aug 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • document that bind.New and Binder support only strictly comparable T
  • identify any, other interface types, and interface-containing structs or arrays as unsupported regardless of their current values
  • describe the direct equality and panic behavior of the default JawsSetLocked implementation
  • align the repository JaWS skill guidance without changing runtime behavior

Closes #246

Verification

  • go doc ./lib/bind New
  • go doc ./lib/bind Binder
  • go doc ./lib/bind Binder.JawsSetLocked
  • go generate ./...
  • go vet ./...
  • gofmt -l .
  • gofumpt -l .
  • staticcheck ./...
  • golangci-lint run
  • gosec ./...
  • go test -race ./lib/bind/...
  • JAWS_REQUIRE_NODE=1 go test -race -coverprofile=coverage.out ./...
  • JAWS_REQUIRE_NODE=1 go test ./...
  • go build -v ./...
  • GOOS=linux GOARCH=386 CGO_ENABLED=0 go test -exec=/usr/bin/true ./lib/bind/...

Document the type-based Binder restriction and default equality panic risk while keeping runtime behavior unchanged. Align the repository JaWS skill with the public contract.
Describe Go constraint satisfaction precisely, state recursive array and struct requirements, and keep JawsSetLocked focused on caller-visible behavior.
@linkdata
linkdata merged commit 8ff5d52 into main Aug 7, 2026
7 checks passed
@linkdata
linkdata deleted the docs/246-strictly-comparable-binder branch August 7, 2026 15:02
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.

docs(bind): require strictly comparable bound value types

1 participant