Skip to content

docs: drop cloudflare-go version pin from doc comments and roadmap#143

Merged
jacaudi merged 1 commit into
mainfrom
chore/cloudflare-go-doc-cleanup
May 27, 2026
Merged

docs: drop cloudflare-go version pin from doc comments and roadmap#143
jacaudi merged 1 commit into
mainfrom
chore/cloudflare-go-doc-cleanup

Conversation

@jacaudi
Copy link
Copy Markdown
Owner

@jacaudi jacaudi commented May 27, 2026

Summary

Follow-up cleanup to #142. Four wrapper-client docstrings under internal/cloudflare/ still said cloudflare-go v6 SDK by version number, and docs/roadmap.md hard-coded /v6 in the module path plus two "as of v6" statements about API surface availability. After the v6→v7 migration in #142, those references are stale; swapping to v7 would just go stale again at v8.

Making them version-agnostic instead — the wrappers wrap "the cloudflare-go SDK" regardless of major; the roadmap discusses cloudflare-go's typed-client surface in general, not a specific release.

Files

  • internal/cloudflare/dns.go:36 — docstring
  • internal/cloudflare/ruleset.go:26 — docstring
  • internal/cloudflare/zone.go:18 — docstring
  • internal/cloudflare/zoneconfig.go:31 — docstring
  • docs/roadmap.md — 3 lines (module path mention + 2 "as of v6" statements)

7 insertions / 7 deletions. No code changes.

Test plan

  • go build ./... clean
  • go vet ./... clean
  • CI green

🤖 Generated with Claude Code

Four wrapper-client docstrings under internal/cloudflare/ said
"cloudflare-go v6 SDK" by version number, and docs/roadmap.md
hard-coded the /v6 module path plus two "as of v6" statements about
API surface availability. After the v7 migration these are stale,
and swapping them to "v7" would just go stale again at v8.

Make them version-agnostic instead — the wrappers wrap "the
cloudflare-go SDK" regardless of major; the roadmap discusses
cloudflare-go's typed-client surface in general, not a specific
release.

No code changes; doc text only. Surfaced by the post-merge review
of the v6→v7 migration as out-of-scope cleanup.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@jacaudi jacaudi merged commit 2d493e6 into main May 27, 2026
7 checks passed
@jacaudi jacaudi deleted the chore/cloudflare-go-doc-cleanup branch May 27, 2026 08:54
@wall-e-one
Copy link
Copy Markdown
Contributor

wall-e-one Bot commented May 27, 2026

🎉 This PR is included in version 0.19.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@wall-e-one wall-e-one Bot added the released label May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant