Prepare the 0.2.0 release: changelog, README, package doc - #15
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The changelog section becomes
0.2.0— it describes what is already onmain,and calling it
Unreleasedwould be wrong the moment the tag is placed.README and
doc.gostill described v0.1.0 only. Neither mentionedParams,Kind,WithDescending,WithCallOptionsorWithTimeout— so everything thetutorial 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:
Paramsnext to the call that takes it, with the alias-ness spelled out —that is what lets it mix with a plain
map[string]any.Kindnext toIsEmpty, because the pair splits one question in two: isanything there, and what is it.
WithDescendingin the walk section, with the warning NOT to reverse aScanby hand: flipping only the order givesorder 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/WithTimeoutright after it, with the gap they close —a walk takes one
ctxfor the whole loop, so otherwise the only choices are adeadline on the entire export or none at all on a page that stalls.
next/totallive inres.Next[id]rather than inside the result, where itis 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 getline, the required Go version, CI and pkg.go.dev badges, and a pointerto
llms.txtfor people writing integrations with an AI agent.Merges cleanly with #16 in either order; CI checked on the combined result.
🤖 Generated with Claude Code