Align the batch docs and changelog with the Node and Python SDKs - #70
Merged
vigneshwerv merged 1 commit intoAug 12, 2026
Merged
Conversation
vigneshwerv
force-pushed
the
docs/align-with-sibling-sdks
branch
from
August 12, 2026 17:33
7bd949e to
c5eea04
Compare
vigneshwerv
changed the base branch from
dev
to
update-sdk-queries/31622934716
August 12, 2026 17:33
The batch section led with a hand-written nested hash and pushed typed payloads into a second section, so the first thing a reader copied was the form we tell them not to use. The Node and Python READMEs both lead with the typed payload, link the batch guide, and close with one line naming the payloads. This matches that shape, and drops the surrounding prose -- atomicity and union handling, unset vs nil, value equality -- that neither sibling documents. 95 lines to 34; theirs are 29. Adds the guide links the sibling READMEs carry and this one was missing: post-to-the-api, batch-ledger-entries, sync-payments#custom-link, reconcile-payments#reconcile-a-tx and read-balances#latest. Every link and anchor was checked against the live docs. The changelog gains the Keep a Changelog preamble both siblings use, and the two batch entries pick up their shared wording. The 2.0.0 section already matched.
vigneshwerv
force-pushed
the
docs/align-with-sibling-sdks
branch
from
August 12, 2026 17:51
c5eea04 to
ba913cb
Compare
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
1 participant
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 batch section led with a hand-written nested hash and pushed typed payloads into a second section, so the first thing a reader copied was the form we tell them not to use.
node-clientandfragment-pythonboth lead with the typed payload, link the batch guide, and close with one line on where the payloads come from — this matches that shape.The Ruby-specific material that neither sibling documents (unset vs
nil,set?, offlineTypedEntries.load, theAddLedgerEntriesErrorunion handling) is kept, moved into the section that follows rather than deleted.Links
Added the guide links the sibling READMEs carry and this one was missing:
post-ledger-entries#post-to-the-apipost-ledger-entries#batch-ledger-entriessync-payments#custom-linkreconcile-payments#reconcile-a-txread-balances#latestAlso adds the
See CHANGELOG.mdpointerfragment-pythoncarries. All eight README links were checked for a 200, and every anchor was confirmed present in the live page HTML.Changelog
Adds the Keep a Changelog preamble both siblings use, naming the gem and noting that releases prior to
2.0.0predate the changelog. The two batch entries pick up the siblings' shared wording, including why GraphQL cannot type each entry'sparametersindividually. The2.0.0section already matched theirs exactly and is untouched.Verified
rake test94 runs, 0 failures;rubocopcleanadd_ledger_entries_test.rbthat claimed the raw hash was "the first example in the README", which this change makes false