Skip to content

Prepare the 0.2.0 release: changelog, README, package doc - #15

Merged
ExaltedTrou6 merged 1 commit into
mainfrom
release/0.2.0
Aug 6, 2026
Merged

Prepare the 0.2.0 release: changelog, README, package doc#15
ExaltedTrou6 merged 1 commit into
mainfrom
release/0.2.0

Conversation

@ExaltedTrou6

Copy link
Copy Markdown
Contributor

The changelog section becomes 0.2.0 — it describes what is already on main,
and calling it Unreleased would be wrong the moment the tag is placed.

README and doc.go still described v0.1.0 only. Neither mentioned Params,
Kind, WithDescending, WithCallOptions or WithTimeout — so everything the
tutorial run turned up was invisible to anyone arriving at the repository or at
pkg.go.dev, which is the first screen most readers ever see.

Added to both, each in the place a reader is already looking:

  • Params next to the call that takes it, with the alias-ness spelled out —
    that is what lets it mix with a plain map[string]any.
  • Kind next to IsEmpty, because the pair splits one question in two: is
    anything there, and what is it.
  • WithDescending in the walk section, with the warning NOT to reverse a
    Scan by hand: flipping only the order gives order DESC + filter >id,
    which asks for rows above the newest one already seen, so the walk stops after
    page one and reports a complete export.
  • WithCallOptions / WithTimeout right after it, with the gap they close —
    a walk takes one ctx for the whole loop, so otherwise the only choices are a
    deadline on the entire export or none at all on a page that stalls.
  • For the batch: commands run in submission order, and per-command
    next/total live in res.Next[id] rather than inside the result, where it
    is the KEY'S PRESENCE that means "there is more".

README also gains what a public repository is expected to have and did not: a
go get line, the required Go version, CI and pkg.go.dev badges, and a pointer
to llms.txt for people writing integrations with an AI agent.

Merges cleanly with #16 in either order; CI checked on the combined result.

🤖 Generated with Claude Code

The changelog section becomes 0.2.0 — it describes what is now on main,
and calling it Unreleased would be wrong the moment the tag is placed.

README and doc.go still described v0.1.0 only. Neither mentioned Params,
Kind, WithDescending, WithCallOptions or WithTimeout, so everything found
by the tutorial run was invisible to anyone arriving at the repository or
at pkg.go.dev — which is the first screen most readers ever see.

Added to both, in the place a reader is already looking:

  - Params next to the call that takes it, with the alias-ness spelled
    out, because that is what lets it mix with a plain map.
  - Kind next to IsEmpty, since the pair splits one question in two:
    is anything there, and what is it.
  - WithDescending in the walk section, with the warning NOT to reverse a
    Scan by hand — flipping only the order silently truncates the export
    to page one.
  - WithCallOptions/WithTimeout right after it, explaining the gap they
    close: a walk takes one ctx for the whole loop.
  - For the batch: commands run in submission order, and per-command
    next/total live in res.Next[id] rather than inside the result, where
    the KEY'S PRESENCE is the signal.

README also gains what a public repository is expected to have and did
not: a go get line, the Go version, CI and pkg.go.dev badges, and a
pointer to llms.txt for people writing integrations with an AI agent.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ExaltedTrou6
ExaltedTrou6 merged commit 2bba8e6 into main Aug 6, 2026
1 check passed
@ExaltedTrou6
ExaltedTrou6 deleted the release/0.2.0 branch August 7, 2026 15:32
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.

1 participant