Skip to content

fix(docs): contradictory description of send in Subcurrency Example#16735

Merged
cameel merged 1 commit into
argotorg:developfrom
thijmau:docs/fix-subcurrency-evaluation-logic
Jun 8, 2026
Merged

fix(docs): contradictory description of send in Subcurrency Example#16735
cameel merged 1 commit into
argotorg:developfrom
thijmau:docs/fix-subcurrency-evaluation-logic

Conversation

@thijmau

@thijmau thijmau commented May 18, 2026

Copy link
Copy Markdown
Contributor

Description

Checklist

AI Disclosure

  • No AI tools were used
  • AI tools were used (details below)

Claude (Anthropic) was used for formatting the original issue body of #16730 and for tidying up the commit message. All technical content was verified by me.

Closes #16730

@czepluch czepluch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. Good catch.

The paragraph described an `if` condition evaluating to true on
insufficient balance, which contradicts the `require(amount <= balance, ...)`
shown in the code. The wording was left over from an earlier version of
the example that used an explicit `if`/`revert` form.

Rewrite to describe the `require` condition directly: it evaluates to
false when the sender has insufficient funds, triggering the revert with
the `InsufficientBalance` error.

Signed-off-by: Thijmen Maus <hi@thijmau.dev>
@cameel cameel force-pushed the docs/fix-subcurrency-evaluation-logic branch from 68a2c34 to 420cac3 Compare June 8, 2026 12:11
@cameel cameel enabled auto-merge June 8, 2026 12:12
@cameel cameel merged commit 839e2c3 into argotorg:develop Jun 8, 2026
82 of 83 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: send description in Subcurrency Example contradicts the require condition

3 participants