docs: carry the business rules the API reference states - #168
Merged
Merged
Conversation
The docs pages and this SDK's docstrings had drifted apart over time. Agent tooling and IDE tooltips read the installed package's docstrings, not the docs site, so the drift was silently steering integrators toward stale or contradictory information. This adjudicates each divergence against the backend (or, where the backend was unavailable in this checkout, against independent cross-SDK corroboration) and carries the winning text into the docstrings here. Comment/docstring lines only -- no behavior changes. Resource families touched: invoice, invoice-pull-subscription, transfer, boleto, boleto-payment, merchant-card (+ its Log), merchant-installment (+ its Log), merchant-purchase (+ its Log), merchant-session (+ its Log), brcode-payment, dynamic-brcode, event, webhook, deposit, transaction, workspace, payment-request, darf-payment, tax-payment, utility-payment, dict-key, split-profile. Also fixes one README.md sample (CorporateWithdrawal) that passed a description argument no constructor accepts. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
thiagosimon-stark
approved these changes
Sep 16, 2026
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.
Summary
descriptionkwarg no constructor accepts.Resource families touched: invoice, invoice-pull-subscription, transfer, boleto, boleto-payment, merchant-card (+ Log), merchant-installment (+ Log), merchant-purchase (+ Log), merchant-session (+ Log), brcode-payment, dynamic-brcode, event, webhook, deposit, transaction, workspace, payment-request, darf-payment, tax-payment, utility-payment, dict-key, split-profile.
Post-review fixes applied on this branch (amended into the single commit):
starkbank/transaction/__transaction.py: removed an unadjudicated "use starkbank.transfer.create instead" recommendation from the deprecatedcreate()docstring (Transfer is not an equivalent replacement for internal inter-workspace transactions); replaced with wording grounded in the actual deprecation behavior.starkbank/splitprofile/__splitprofile.py: removed the undocumentedreceiver_idsparameter bullet frompage()'s docstring per DECISIONS §6 L-033 (text-only; the kwarg itself is unchanged, still silently forwarded and unsupported by the API — a separate code-level cleanup, not in scope here).Test plan
python3 -m compileall -qon all 26 changed .py files — exit 0git status --shortclean; branch exactly 1 commit ahead of master🤖 Generated with Claude Code