Skip to content

Commit

Permalink
docs: fix natspec for _transfer* internal functions
Browse files Browse the repository at this point in the history
  • Loading branch information
amusingaxl committed Nov 26, 2024
1 parent cc68e16 commit a8cba91
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/DssSpell.sol
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,9 @@ contract DssSpellAction is DssAction {
ProxyLike(SPARK_PROXY).exec(SPARK_SPELL, abi.encodeWithSignature("execute()"));
}

/// @notice wraps the operations required to transfer USDS from the surplus buffer
/// @notice wraps the operations required to transfer USDS from the surplus buffer.
/// @param usr The USDS receiver.
/// @param wad The USDS amount in wad precision (10**18)
/// @param wad The USDS amount in wad precision (10 ** 18).
function _transferUsds(address usr, uint256 wad) internal {
// Note: Enforce whole units to avoid rounding errors
require(wad % WAD == 0, "transferUsds/non-integer-wad");
Expand All @@ -335,9 +335,9 @@ contract DssSpellAction is DssAction {
DaiUsdsLike(DAI_USDS).daiToUsds(usr, wad);
}

/// @notice wraps the operations required to transfer SKY from the surplus buffer
/// @notice wraps the operations required to transfer SKY from the treasury.
/// @param usr The SKY receiver.
/// @param wad The SKY amount in wad precision (10**18).
/// @param wad The SKY amount in wad precision (10 ** 18).
function _transferSky(address usr, uint256 wad) internal {
// Note: Enforce exact conversion to avoid rounding errors
require(wad % MKR_SKY_RATE == 0, "transferSky/non-exact-conversion");
Expand Down

0 comments on commit a8cba91

Please sign in to comment.