chore: fix typo in comment

[gap-editor]

PR-Codex overview

This PR focuses on correcting a typo in the documentation comments of the IEscrow interface in the createNativeTransaction and createERC20Transaction functions.

Detailed summary

• Corrected the typo from "finds" to "funds" in the documentation for the _buyer parameter in both createNativeTransaction and createERC20Transaction functions.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

• Documentation
  • Corrected typos in buyer parameter descriptions within the escrow interface comments, clarifying that the buyer provides funds on their behalf for both native and ERC20 transaction creation.
  • Improves clarity and consistency for integrators and auditors.
  • No changes to behavior or public APIs; purely editorial updates.

[netlify]

👷 Deploy request for kleros-escrow-v2 pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	acfec28

[coderabbitai]

Walkthrough

Documentation typos corrected in comments for buyer parameters within IEscrow.sol’s createNativeTransaction and createERC20Transaction functions. No code logic, signatures, or behavior changed.

Changes

Cohort / File(s)	Summary
Docs typo fixes contracts/src/interfaces/IEscrow.sol	Corrected comment typos: “provides finds” → “provides funds” in buyer parameter descriptions for createNativeTransaction and createERC20Transaction. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my ears at tidy prose so fine,
A coin of “funds” replaces “finds” in line.
No codepaths shift, no gas is spent,
Just cleaner docs where meaning went.
Thump-thump! I stamp, content and proud—
Small fixes make the burrow wowed.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

contracts/src/interfaces/IEscrow.sol (1)

79-79: Nit: tighten phrasing for clarity

Consider “on behalf of the buyer” to avoid the ambiguous “their”.

Apply:

-/// @param _buyer Party that pays for the transaction. Note that msg.sender can provide funds on their behalf.
+/// @param _buyer Party that pays for the transaction. Note: msg.sender can provide funds on behalf of the buyer.

Also applies to: 94-94

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7dd88a4 and acfec28.

📒 Files selected for processing (1)

• contracts/src/interfaces/IEscrow.sol (2 hunks)

🔇 Additional comments (1)

contracts/src/interfaces/IEscrow.sol (1)

79-79: Typo corrected in IEscrow.sol — no further occurrences in source

I ran the suggested ripgrep search and only found the typo in auto-generated JSON metadata (not in any live Solidity files). No other “provides finds” or similar variants remain in the codebase. LGTM.