Skip to content

docs: fix typo sandwhiching -> sandwiching#132

Open
phessophissy wants to merge 2 commits intoInverseFinance:mainfrom
phessophissy:fix/typo-sandwiching
Open

docs: fix typo sandwhiching -> sandwiching#132
phessophissy wants to merge 2 commits intoInverseFinance:mainfrom
phessophissy:fix/typo-sandwiching

Conversation

@phessophissy
Copy link

@phessophissy phessophissy commented Jan 9, 2026

Description

Documentation improvements for the FiRM codebase.

Changes

1. Typo Fix

  • Fixed "sandwhiching" → "sandwiching" (6 occurrences in OffchainAbstractHelper.sol)

2. NatSpec Documentation

  • Added complete NatSpec documentation to IConvexBooster interface:
    • @title, @notice, @dev for the interface
    • @notice and @param for each function (withdraw, deposit, earmarkRewards)
    • Added missing SPDX license identifier

Files Changed

  • src/util/OffchainAbstractHelper.sol
  • src/interfaces/IConvexBooster.sol

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.

1 participant