Skip to content

Commit

Permalink
improve(docstrings): Follow up fixes (#269)
Browse files Browse the repository at this point in the history
- In Polygon_Adapter.sol, the user parameter for the depositEtherFor function is documented using "@dev" instead of "@param user".
- In SpokePool.sol, within the RelayExecution struct's relay parameter description, "parametersin" should be "parameters in".
- In SpokePool.sol, the RelayExecution struct's docstring for parameter payoutAdjustmentPct lists it as "payoutAdjustment".
  • Loading branch information
nicholaspai authored Mar 31, 2023
1 parent ef59e2a commit 146f2f2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions contracts/SpokePool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ abstract contract SpokePool is
/**
* @notice Represents data used to fill a deposit.
* @param relay Relay containing original data linked to deposit. Contains fields that can be
* overridden by other parametersin the RelayExecution struct.
* overridden by other parameters in the RelayExecution struct.
* @param relayHash Hash of the relay data.
* @param updatedRelayerFeePct Actual relayer fee pct to use for this relay.
* @param updatedRecipient Actual recipient to use for this relay.
Expand All @@ -200,8 +200,8 @@ abstract contract SpokePool is
* @param maxTokensToSend Max number of tokens to pull from relayer.
* @param maxCount Max count to protect the relayer from frontrunning.
* @param slowFill Whether this is a slow fill.
* @param payoutAdjustment Adjustment to the payout amount. Can be used to increase or decrease the payout to allow
* for rewards or penalties. Used in slow fills.
* @param payoutAdjustmentPct Adjustment to the payout amount. Can be used to increase or decrease the payout to
* allow for rewards or penalties. Used in slow fills.
*/
struct RelayExecution {
RelayData relay;
Expand Down
2 changes: 1 addition & 1 deletion contracts/chain-adapters/Polygon_Adapter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
interface IRootChainManager {
/**
* @notice Send msg.value of ETH to Polygon
* @dev Recipient of ETH on Polygon.
* @param user Recipient of ETH on Polygon.
*/
function depositEtherFor(address user) external payable;

Expand Down

0 comments on commit 146f2f2

Please sign in to comment.