Skip to content

docs: carry the business rules the API reference states - #168

Merged
edu-stark merged 1 commit into
masterfrom
fix/docstring-business-rules
Sep 16, 2026
Merged

edu-stark merged 1 commit into
masterfrom
fix/docstring-business-rules

Conversation

@edu-stark

Copy link
Copy Markdown
Contributor

Summary

  • Adjudicated docs/SDK docstring drift for starkbank/sdk-python: carries the winning business-rule text (per DECISIONS.md §6, backed by PLAN.md §2.1 where undisputed) into docstrings across 20 resource families, since agent tooling and IDE tooltips read the installed package's docstrings, not the docs site.
  • Fixes one README.md sample (CorporateWithdrawal) that passed a description kwarg no constructor accepts.
  • Comment/docstring lines only — no behavior changes; verified via a tokenize-based checker that every changed line in every touched .py file falls inside a docstring or comment span.

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 deprecated create() 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 undocumented receiver_ids parameter bullet from page()'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 -q on all 26 changed .py files — exit 0
  • Tokenize-based diff checker confirms every changed line (old and new) across all 26 files falls inside a docstring/comment token span
  • No trailing whitespace introduced on any added line
  • git status --short clean; branch exactly 1 commit ahead of master
  • CHANGELOG.md entry added (repo has precedent: identical "### Fixed / - Docstrings" entries at v0.2.0 and v0.2.1)

🤖 Generated with Claude Code

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>
@edu-stark
edu-stark merged commit 575279b into master Sep 16, 2026
3 of 4 checks passed
@edu-stark
edu-stark deleted the fix/docstring-business-rules branch September 16, 2026 12:25
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.

2 participants