@bananapus/core-v6 0.0.39 → 0.0.41

package/src/JBTerminalStore.sol

@@ -227,9 +227,9 @@ contract JBTerminalStore is IJBTerminalStore {
         }
     }
 
-    /// @notice Records funds being added to a project's balance.
-    /// @param projectId The ID of the project which funds are being added to the balance of.
-    /// @param token The token being added to the balance.
+    /// @notice Records funds added to a project's balance.
+    /// @param projectId The ID of the project which funds are added to the balance of.
+    /// @param token The token to add to the balance.
     /// @param amount The amount of terminal tokens added, as a fixed point number with the same amount of decimals as
     /// its relative terminal.
     function recordAddedBalanceFor(uint256 projectId, address token, uint256 amount) external override {
@@ -241,10 +241,10 @@ contract JBTerminalStore is IJBTerminalStore {
     /// @dev Uses the data hook if configured, otherwise applies the bonding curve formula based on cash out tax rate,
     /// surplus, and supply. The terminal calls this before actually burning tokens and transferring funds.
     /// @param holder The account that is cashing out tokens.
-    /// @param projectId The ID of the project being cashed out from.
+    /// @param projectId The ID of the project to cash out from.
     /// @param cashOutCount The number of project tokens to cash out, as supplied by the caller and later burned by the
     /// terminal, as a fixed point number with 18 decimals.
-    /// @param tokenToReclaim The token being reclaimed by the cash out.
+    /// @param tokenToReclaim The token to reclaim by the cash out.
     /// @param beneficiaryIsFeeless Whether the cash out's beneficiary is a feeless address. Passed through to data
     /// hooks so they can skip their own fees when value stays in the protocol (e.g. project-to-project routing).
     /// @param metadata Bytes to send to the data hook, if the project's current ruleset specifies one.
@@ -318,9 +318,9 @@ contract JBTerminalStore is IJBTerminalStore {
     /// current ruleset's weight. Uses the data hook if configured, otherwise mints proportionally.
     /// @dev Called by the terminal after accepting funds. Updates the project's recorded balance.
     /// @param payer The address that made the payment to the terminal.
-    /// @param amount The amount of tokens being paid. Includes the token being paid, their value, the number of
+    /// @param amount The amount of tokens to pay. Includes the token paid, their value, the number of
     /// decimals included, and the currency of the amount.
-    /// @param projectId The ID of the project being paid.
+    /// @param projectId The ID of the project to pay.
     /// @param beneficiary The address that should be the beneficiary of anything the payment yields (including project
     /// tokens minted by the payment).
     /// @param metadata Bytes to send to the data hook, if the project's current ruleset specifies one.
@@ -362,7 +362,7 @@ contract JBTerminalStore is IJBTerminalStore {
     /// @dev Reverts if the total payouts for this cycle would exceed the ruleset's payout limit. The balance is
     /// decremented before validation (safe because the entire tx reverts atomically on failure).
     /// @param projectId The ID of the project that is paying out funds.
-    /// @param token The token being paid out.
+    /// @param token The token to pay out.
     /// @param amount The amount to pay out (use from the payout limit), as a fixed point number.
     /// @param currency The currency of the `amount`. This must match the project's current ruleset's currency.
     /// @return ruleset The ruleset the payout was made during, as a `JBRuleset` struct.
@@ -432,12 +432,12 @@ contract JBTerminalStore is IJBTerminalStore {
         usedPayoutLimitOf[msg.sender][projectId][token][ruleset.cycleNumber][currency] = newUsedPayoutLimitOf;
     }
 
-    /// @notice Records a terminal migration — zeros out the project's balance and returns the amount being moved to
+    /// @notice Records a terminal migration — zeros out the project's balance and returns the amount moved to
     /// the new terminal. The current ruleset must allow terminal migration.
-    /// @param projectId The ID of the project being migrated.
-    /// @param token The token being migrated.
-    /// @return balance The project's current balance (which is being migrated), as a fixed point number with the same
-    /// amount of decimals as its relative terminal.
+    /// @param projectId The ID of the project to migrate.
+    /// @param token The token to migrate.
+    /// @return balance The project's current balance (the amount that will migrate), as a fixed point number with the
+    /// same amount of decimals as its relative terminal.
     function recordTerminalMigration(uint256 projectId, address token) external override returns (uint256 balance) {
         // Get a reference to the project's current ruleset.
         JBRuleset memory ruleset = RULESETS.currentOf(projectId);
@@ -459,10 +459,10 @@ contract JBTerminalStore is IJBTerminalStore {
     /// @dev Called by the terminal during `useAllowanceOf`. Unlike payouts, surplus withdrawals go directly to a
     /// beneficiary rather than through splits.
     /// @param projectId The ID of the project to use the surplus allowance of.
-    /// @param token The token whose balances should contribute to the surplus allowance being reclaimed from.
+    /// @param token The token whose balances should contribute to the surplus allowance to reclaim from.
     /// @param amount The amount to use from the surplus allowance, as a fixed point number.
     /// @param currency The currency of the `amount`. Must match the currency of the surplus allowance.
-    /// @return ruleset The ruleset during the surplus allowance is being used during, as a `JBRuleset` struct.
+    /// @return ruleset The ruleset the surplus allowance applies to, as a `JBRuleset` struct.
     /// @return usedAmount The amount of terminal tokens used, as a fixed point number with the same amount of decimals
     /// as its relative terminal.
     function recordUsedAllowanceOf(
@@ -697,9 +697,9 @@ contract JBTerminalStore is IJBTerminalStore {
     /// preview and execution).
     /// @param terminal The terminal to simulate the cash out from.
     /// @param holder The address cashing out.
-    /// @param projectId The ID of the project being cashed out from.
-    /// @param cashOutCount The number of project tokens being cashed out.
-    /// @param tokenToReclaim The token being reclaimed.
+    /// @param projectId The ID of the project to cash out from.
+    /// @param cashOutCount The number of project tokens to cash out.
+    /// @param tokenToReclaim The token to reclaim.
     /// @param beneficiaryIsFeeless Whether the cash out's beneficiary is a feeless address.
     /// @param metadata Extra data to pass along to the data hook.
     /// @return ruleset The project's current ruleset.
@@ -741,8 +741,8 @@ contract JBTerminalStore is IJBTerminalStore {
     /// `recordPaymentFrom` would produce.
     /// @param terminal The terminal to simulate the payment from.
     /// @param payer The address of the payer.
-    /// @param amount The amount being paid.
-    /// @param projectId The ID of the project being paid.
+    /// @param amount The amount to pay.
+    /// @param projectId The ID of the project to pay.
     /// @param beneficiary The address to mint project tokens to.
     /// @param metadata Extra data to pass along to the data hook.
     /// @return ruleset The project's current ruleset.
@@ -841,9 +841,9 @@ contract JBTerminalStore is IJBTerminalStore {
     /// @dev When `useTotalSurplusForCashOuts` is enabled, surplus is aggregated from ALL registered terminals without
     /// validation. Projects MUST only register trusted terminals — an untrusted terminal can over-report surplus and
     /// cause the executing terminal to overpay cash-outs.
-    /// @param terminal The terminal the cash out is being recorded from.
-    /// @param projectId The ID of the project being cashed out from.
-    /// @param tokenToReclaim The token being reclaimed.
+    /// @param terminal The terminal recording the cash out.
+    /// @param projectId The ID of the project to cash out from.
+    /// @param tokenToReclaim The token to reclaim.
     /// @param ruleset The ruleset during the cash out.
     /// @return The surplus amount in the token's native decimals and currency.
     function _cashOutSurplusOf(
@@ -939,9 +939,9 @@ contract JBTerminalStore is IJBTerminalStore {
     /// @notice Computes cash out results without writing state.
     /// @param terminal The terminal recording the cash out.
     /// @param holder The account that is cashing out tokens.
-    /// @param projectId The ID of the project being cashed out from.
+    /// @param projectId The ID of the project to cash out from.
     /// @param cashOutCount The number of project tokens to cash out.
-    /// @param tokenToReclaim The token being reclaimed.
+    /// @param tokenToReclaim The token to reclaim.
     /// @param beneficiaryIsFeeless Whether the cash out's beneficiary is a feeless address.
     /// @param metadata Bytes to send to the data hook.
     /// @return ruleset The ruleset during the cash out.
@@ -1035,8 +1035,8 @@ contract JBTerminalStore is IJBTerminalStore {
     /// @notice Computes payment results without writing state.
     /// @param terminal The terminal recording the payment.
     /// @param payer The address that made the payment.
-    /// @param amount The amount of tokens being paid.
-    /// @param projectId The ID of the project being paid.
+    /// @param amount The amount of tokens to pay.
+    /// @param projectId The ID of the project to pay.
     /// @param beneficiary The beneficiary of the payment.
     /// @param metadata Bytes to send to the data hook.
     /// @return ruleset The ruleset the payment would be made during.
@@ -1239,12 +1239,12 @@ contract JBTerminalStore is IJBTerminalStore {
 
     /// @notice Gets a project's surplus amount in a terminal as measured by a given ruleset, across multiple accounting
     /// contexts.
-    /// @dev This amount changes as the value of the balance changes in relation to the currency being used to measure
+    /// @dev This amount changes as the value of the balance changes in relation to the currency used to measure
     /// various payout limits.
-    /// @param terminal The terminal the surplus is being calculated for.
+    /// @param terminal The terminal to calculate surplus for.
     /// @param projectId The ID of the project to get the surplus for.
     /// @param accountingContexts The accounting contexts of tokens whose balances should contribute to the surplus
-    /// being calculated.
+    /// calculated.
     /// @param ruleset The ruleset to base the surplus on.
     /// @param targetDecimals The number of decimals to include in the resulting fixed point number.
     /// @param targetCurrency The currency that the reported surplus is expected to be in terms of.
@@ -1285,12 +1285,12 @@ contract JBTerminalStore is IJBTerminalStore {
 
     /// @notice Get a project's surplus amount of a specific token in a given terminal as measured by a given ruleset
     /// (one specific accounting context).
-    /// @dev This amount changes as the value of the balance changes in relation to the currency being used to measure
+    /// @dev This amount changes as the value of the balance changes in relation to the currency used to measure
     /// the payout limits.
-    /// @param terminal The terminal the surplus is being calculated for.
+    /// @param terminal The terminal to calculate surplus for.
     /// @param projectId The ID of the project to get the surplus of.
     /// @param accountingContext The accounting context of the token whose balance should contribute to the surplus
-    /// being measured.
+    /// measured.
     /// @param ruleset The ID of the ruleset to base the surplus calculation on.
     /// @param targetDecimals The number of decimals to include in the resulting fixed point number.
     /// @param targetCurrency The currency that the reported surplus is expected to be in terms of.

package/src/JBTokens.sol

@@ -47,7 +47,7 @@ contract JBTokens is JBControlled, IJBTokens {
     /// @custom:param projectId The ID of the project to which the credits belong.
     mapping(address holder => mapping(uint256 projectId => uint256)) public override creditBalanceOf;
 
-    /// @notice Each token's project.
+    /// @notice The project ID that a given ERC-20 token is associated with.
     /// @custom:param token The address of the token associated with the project.
     // slither-disable-next-line unused-return
     mapping(IJBToken token => uint256) public override projectIdOf;
@@ -77,7 +77,7 @@ contract JBTokens is JBControlled, IJBTokens {
     /// @notice Destroy a holder's tokens for a project. Credits (internal balance) are burned first; if more tokens
     /// need burning, the remaining amount is burned from the holder's ERC-20 balance.
     /// @dev Only a project's current controller can burn its tokens. Called during cash outs and manual burns.
-    /// @param holder The address that owns the tokens which are being burned.
+    /// @param holder The address to burn tokens from.
     /// @param projectId The ID of the project the burned tokens belong to.
     /// @param count The number of tokens to burn.
     function burnFrom(address holder, uint256 projectId, uint256 count) external override onlyControllerOf(projectId) {
@@ -135,8 +135,8 @@ contract JBTokens is JBControlled, IJBTokens {
     /// balance and the equivalent ERC-20 tokens are minted to the beneficiary. The project must have an ERC-20
     /// deployed or attached.
     /// @dev Only a project's controller can claim that project's tokens.
-    /// @param holder The owner of the credits being redeemed.
-    /// @param projectId The ID of the project whose tokens are being claimed.
+    /// @param holder The owner of the credits to redeem.
+    /// @param projectId The ID of the project to claim tokens for.
     /// @param count The number of tokens to claim.
     /// @param beneficiary The account into which the claimed tokens will go.
     function claimTokensFor(
@@ -317,7 +317,7 @@ contract JBTokens is JBControlled, IJBTokens {
     /// @notice Update the name and symbol of a project's ERC-20 token. The project must already have a token deployed
     /// or attached.
     /// @dev Only a project's controller can set the token's name and symbol.
-    /// @param projectId The ID of the project whose token is being updated.
+    /// @param projectId The ID of the project to update the token for.
     /// @param name The new name.
     /// @param symbol The new symbol.
     function setTokenMetadataFor(
@@ -351,7 +351,7 @@ contract JBTokens is JBControlled, IJBTokens {
     /// just a balance in this contract), so this function enables transfers via the controller.
     /// @dev Only a project's controller can transfer credits for that project.
     /// @param holder The address to transfer credits from.
-    /// @param projectId The ID of the project whose credits are being transferred.
+    /// @param projectId The ID of the project to transfer credits for.
     /// @param recipient The recipient of the credits.
     /// @param count The number of token credits to transfer.
     function transferCreditsFrom(

package/src/interfaces/IJBCashOutTerminal.sol

@@ -12,11 +12,11 @@ interface IJBCashOutTerminal is IJBTerminal {
     /// @notice A cash out was processed for a project.
     /// @param rulesetId The ID of the ruleset during the cash out.
     /// @param rulesetCycleNumber The cycle number of the ruleset during the cash out.
-    /// @param projectId The ID of the project being cashed out from.
+    /// @param projectId The ID of the project to cash out from.
     /// @param holder The address whose tokens were cashed out.
     /// @param beneficiary The address that received the reclaimed funds.
     /// @param cashOutCount The number of tokens cashed out.
-    /// @param cashOutTaxRate The cash out tax rate applied.
+    /// @param cashOutTaxRate The cash out tax rate applied, out of `JBConstants.MAX_CASH_OUT_TAX_RATE`.
     /// @param reclaimAmount The amount of funds reclaimed.
     /// @param metadata Extra metadata associated with the cash out.
     /// @param caller The address that called the cash out function.
@@ -48,8 +48,8 @@ interface IJBCashOutTerminal is IJBTerminal {
     );
 
     /// @notice Simulates cashing out project tokens from this terminal without modifying state.
-    /// @param holder The address whose tokens are being cashed out.
-    /// @param projectId The ID of the project whose tokens are being cashed out.
+    /// @param holder The address cashing out tokens.
+    /// @param projectId The ID of the project cashing out tokens.
     /// @param cashOutCount The number of project tokens to cash out.
     /// @param tokenToReclaim The token to reclaim from the project's surplus.
     /// @param beneficiary The address that would receive the reclaimed tokens.
@@ -77,8 +77,8 @@ interface IJBCashOutTerminal is IJBTerminal {
 
     /// @notice Cashes out a holder's tokens for a project, reclaiming the token's proportional share of the project's
     /// surplus.
-    /// @param holder The address whose tokens are being cashed out.
-    /// @param projectId The ID of the project whose tokens are being cashed out.
+    /// @param holder The address cashing out tokens.
+    /// @param projectId The ID of the project cashing out tokens.
     /// @param cashOutCount The number of project tokens to cash out.
     /// @param tokenToReclaim The token to reclaim from the project's surplus.
     /// @param minTokensReclaimed The minimum number of terminal tokens expected to be reclaimed.

package/src/interfaces/IJBController.sol

@@ -69,7 +69,7 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
     /// @param tokenCount The total number of tokens minted, including reserved tokens.
     /// @param beneficiaryTokenCount The number of tokens minted for the beneficiary.
     /// @param memo A memo associated with the mint.
-    /// @param reservedPercent The reserved percent applied to the mint.
+    /// @param reservedPercent The reserved percent applied to the mint, out of `JBConstants.MAX_RESERVED_PERCENT`.
     /// @param caller The address that called the mint function.
     event MintTokens(
         address indexed beneficiary,
@@ -82,8 +82,8 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
     );
 
     /// @notice A project was prepared for migration from another controller.
-    /// @param projectId The ID of the project being prepared for migration.
-    /// @param from The controller the project is being migrated from.
+    /// @param projectId The ID of the project to prepare for migration.
+    /// @param from The controller to migrate from.
     /// @param caller The address that called the prep migration function.
     event PrepMigration(uint256 indexed projectId, address from, address caller);
 
@@ -226,7 +226,7 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
     function pendingReservedTokenBalanceOf(uint256 projectId) external view returns (uint256);
 
     /// @notice Previews how many beneficiary and reserved tokens `mintTokensOf(...)` would produce.
-    /// @param projectId The ID of the project whose tokens are being minted.
+    /// @param projectId The ID of the project to mint tokens for.
     /// @param tokenCount The number of tokens to mint, including any reserved tokens.
     /// @param useReservedPercent Whether to apply the ruleset's reserved percent.
     /// @return beneficiaryTokenCount The number of tokens that would be minted for the beneficiary.
@@ -257,7 +257,7 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
     /// @notice Adds a price feed for a project.
     /// @param projectId The ID of the project to add the feed for.
     /// @param pricingCurrency The currency the feed's output price is in terms of.
-    /// @param unitCurrency The currency being priced by the feed.
+    /// @param unitCurrency The currency the feed prices.
     /// @param feed The price feed to add.
     function addPriceFeedFor(
         uint256 projectId,
@@ -268,15 +268,15 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
         external;
 
     /// @notice Burns a holder's project tokens or credits.
-    /// @param holder The address whose tokens are being burned.
-    /// @param projectId The ID of the project whose tokens are being burned.
+    /// @param holder The address to burn tokens for.
+    /// @param projectId The ID of the project to burn tokens for.
     /// @param tokenCount The number of tokens to burn.
     /// @param memo A memo to pass along to the emitted event.
     function burnTokensOf(address holder, uint256 projectId, uint256 tokenCount, string calldata memo) external;
 
     /// @notice Redeems credits to claim tokens into a beneficiary's account.
     /// @param holder The address to redeem credits from.
-    /// @param projectId The ID of the project whose tokens are being claimed.
+    /// @param projectId The ID of the project to claim tokens for.
     /// @param tokenCount The number of tokens to claim.
     /// @param beneficiary The account the claimed tokens will go to.
     function claimTokensFor(address holder, uint256 projectId, uint256 tokenCount, address beneficiary) external;
@@ -331,7 +331,7 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
         returns (uint256 rulesetId);
 
     /// @notice Mints new project tokens or credits to a beneficiary, optionally reserving a portion.
-    /// @param projectId The ID of the project whose tokens are being minted.
+    /// @param projectId The ID of the project to mint tokens for.
     /// @param tokenCount The number of tokens to mint, including any reserved tokens.
     /// @param beneficiary The address which will receive the non-reserved tokens.
     /// @param memo A memo to pass along to the emitted event.
@@ -377,14 +377,14 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
     function setTokenFor(uint256 projectId, IJBToken token) external;
 
     /// @notice Sets the name and symbol of a project's token.
-    /// @param projectId The ID of the project whose token is being updated.
+    /// @param projectId The ID of the project to update the token for.
     /// @param name The new name.
     /// @param symbol The new symbol.
     function setTokenMetadataOf(uint256 projectId, string calldata name, string calldata symbol) external;
 
     /// @notice Transfers credits from one address to another.
     /// @param holder The address to transfer credits from.
-    /// @param projectId The ID of the project whose credits are being transferred.
+    /// @param projectId The ID of the project to transfer credits for.
     /// @param recipient The address to transfer credits to.
     /// @param creditCount The number of credits to transfer.
     function transferCreditsFrom(address holder, uint256 projectId, address recipient, uint256 creditCount) external;

package/src/interfaces/IJBMigratable.sol

@@ -12,17 +12,17 @@ interface IJBMigratable is IERC165 {
     event Migrate(uint256 indexed projectId, IERC165 to, address caller);
 
     /// @notice Called after this controller has been set as the project's controller in the directory.
-    /// @param from The controller being migrated from.
+    /// @param from The controller to migrate from.
     /// @param projectId The ID of the project that was migrated.
     function afterReceiveMigrationFrom(IERC165 from, uint256 projectId) external;
 
-    /// @notice Prepares this controller to receive a project being migrated from another controller.
-    /// @param from The controller being migrated from.
-    /// @param projectId The ID of the project being migrated.
+    /// @notice Prepares this controller to receive a project to migrate from another controller.
+    /// @param from The controller to migrate from.
+    /// @param projectId The ID of the project to migrate.
     function beforeReceiveMigrationFrom(IERC165 from, uint256 projectId) external;
 
     /// @notice Migrates a project from this controller to another.
-    /// @param projectId The ID of the project being migrated.
+    /// @param projectId The ID of the project to migrate.
     /// @param to The controller to migrate the project to.
     function migrate(uint256 projectId, IERC165 to) external;
 }

package/src/interfaces/IJBPayoutTerminal.sol

@@ -17,7 +17,7 @@ interface IJBPayoutTerminal is IJBTerminal {
     /// @notice A direct payout transfer reverted.
     /// @param projectId The ID of the project the payout was for.
     /// @param addr The address the payout was sent to.
-    /// @param token The token being paid out.
+    /// @param token The token to pay out.
     /// @param amount The amount of the payout.
     /// @param fee The fee taken from the payout.
     /// @param reason The revert reason.
@@ -98,7 +98,7 @@ interface IJBPayoutTerminal is IJBTerminal {
 
     /// @notice Sends a project's payouts to its payout split group according to its ruleset's payout limits.
     /// @param projectId The ID of the project to send payouts for.
-    /// @param token The token being paid out.
+    /// @param token The token to pay out.
     /// @param amount The total amount of tokens to pay out.
     /// @param currency The currency the amount is denominated in.
     /// @param minTokensPaidOut The minimum number of terminal tokens expected to be paid out.
@@ -115,7 +115,7 @@ interface IJBPayoutTerminal is IJBTerminal {
 
     /// @notice Uses a project's surplus allowance to send funds to a beneficiary.
     /// @param projectId The ID of the project to use the surplus allowance of.
-    /// @param token The token being paid out.
+    /// @param token The token to pay out.
     /// @param amount The amount of the surplus allowance to use.
     /// @param currency The currency the amount is denominated in.
     /// @param minTokensPaidOut The minimum number of terminal tokens expected to be paid out.

package/src/interfaces/IJBPermissions.sol

@@ -27,7 +27,7 @@ interface IJBPermissions {
 
     /// @notice Checks if an operator has a specific permission for an account and project.
     /// @param operator The operator to check.
-    /// @param account The account being operated on behalf of.
+    /// @param account The account the operator acts on behalf of.
     /// @param projectId The project ID the permission is scoped to. 0 represents all projects.
     /// @param permissionId The permission ID to check for.
     /// @param includeRoot Whether to return true if the operator has the ROOT permission.
@@ -47,7 +47,7 @@ interface IJBPermissions {
 
     /// @notice Checks if an operator has all of the specified permissions for an account and project.
     /// @param operator The operator to check.
-    /// @param account The account being operated on behalf of.
+    /// @param account The account the operator acts on behalf of.
     /// @param projectId The project ID the permissions are scoped to. 0 represents all projects.
     /// @param permissionIds An array of permission IDs to check for.
     /// @param includeRoot Whether to return true if the operator has the ROOT permission.
@@ -67,13 +67,13 @@ interface IJBPermissions {
 
     /// @notice Returns the packed permissions that an operator has for an account and project.
     /// @param operator The address of the operator.
-    /// @param account The address of the account being operated on behalf of.
+    /// @param account The address of the account operated on behalf of.
     /// @param projectId The project ID the permissions are scoped to. 0 is a wildcard for all projects.
     /// @return The packed permissions as a uint256 bitmap.
     function permissionsOf(address operator, address account, uint256 projectId) external view returns (uint256);
 
     /// @notice Sets permissions for an operator on behalf of an account.
     /// @param account The account setting its operator's permissions.
-    /// @param permissionsData The data specifying the permissions the operator is being given.
+    /// @param permissionsData The data specifying the permissions to grant to the operator.
     function setPermissionsFor(address account, JBPermissionsData calldata permissionsData) external;
 }

package/src/interfaces/IJBPermitTerminal.sol

@@ -13,7 +13,7 @@ interface IJBPermitTerminal is IJBTerminal {
     /// @param reason The failure reason.
     event Permit2AllowanceFailed(address indexed token, address indexed owner, bytes reason);
 
-    /// @notice The Permit2 contract used for token approvals.
+    /// @notice The Permit2 contract used for gasless ERC-20 token approvals during payments.
     // forge-lint: disable-next-line(mixed-case-function)
     function PERMIT2() external returns (IPermit2);
 }

package/src/interfaces/IJBPrices.sol

@@ -11,7 +11,7 @@ interface IJBPrices {
     /// @notice A price feed was added for a project's currency pair.
     /// @param projectId The ID of the project the price feed was added for.
     /// @param pricingCurrency The currency the feed's output price is in terms of.
-    /// @param unitCurrency The currency being priced by the feed.
+    /// @param unitCurrency The currency the feed prices.
     /// @param feed The price feed that was added.
     /// @param caller The address that added the price feed.
     event AddPriceFeed(
@@ -31,7 +31,7 @@ interface IJBPrices {
     /// @notice Returns the price feed for a project's currency pair.
     /// @param projectId The ID of the project to get the price feed of.
     /// @param pricingCurrency The currency the feed's output price is in terms of.
-    /// @param unitCurrency The currency being priced by the feed.
+    /// @param unitCurrency The currency the feed prices.
     /// @return The price feed for the currency pair.
     function priceFeedFor(
         uint256 projectId,
@@ -45,7 +45,7 @@ interface IJBPrices {
     /// @notice Returns the unit price for a currency pair.
     /// @param projectId The ID of the project to get the price for.
     /// @param pricingCurrency The currency the returned price is in terms of.
-    /// @param unitCurrency The currency being priced.
+    /// @param unitCurrency The currency to price.
     /// @param decimals The number of decimals the returned price should use.
     /// @return The unit price.
     function pricePerUnitOf(
@@ -61,7 +61,7 @@ interface IJBPrices {
     /// @notice Adds a price feed for a project's currency pair.
     /// @param projectId The ID of the project to add the price feed for.
     /// @param pricingCurrency The currency the feed's output price is in terms of.
-    /// @param unitCurrency The currency being priced by the feed.
+    /// @param unitCurrency The currency the feed prices.
     /// @param feed The price feed to add.
     function addPriceFeedFor(
         uint256 projectId,

package/src/interfaces/IJBRulesets.sol

@@ -22,7 +22,8 @@ interface IJBRulesets {
     /// @param projectId The ID of the project the ruleset was queued for.
     /// @param duration The duration of the ruleset in seconds.
     /// @param weight The weight of the ruleset.
-    /// @param weightCutPercent The percent by which the weight decreases each cycle.
+    /// @param weightCutPercent The percent by which the weight decreases each cycle, out of
+    /// `JBConstants.MAX_WEIGHT_CUT_PERCENT`.
     /// @param approvalHook The approval hook for the ruleset.
     /// @param metadata The packed ruleset metadata.
     /// @param mustStartAtOrAfter The earliest time the ruleset can start.
@@ -89,7 +90,8 @@ interface IJBRulesets {
     /// @param baseRulesetStart The start time of the base ruleset.
     /// @param baseRulesetDuration The duration of the base ruleset.
     /// @param baseRulesetWeight The weight of the base ruleset.
-    /// @param baseRulesetWeightCutPercent The weight cut percent of the base ruleset.
+    /// @param baseRulesetWeightCutPercent The weight cut percent of the base ruleset, out of
+    /// `JBConstants.MAX_WEIGHT_CUT_PERCENT`.
     /// @param baseRulesetCacheId The cache ID of the base ruleset.
     /// @param start The start time to derive the weight for.
     /// @return weight The derived weight.
@@ -150,7 +152,8 @@ interface IJBRulesets {
     /// @param projectId The ID of the project to queue the ruleset for.
     /// @param duration The duration of the ruleset in seconds.
     /// @param weight The weight of the ruleset.
-    /// @param weightCutPercent The percent by which the weight decreases each cycle.
+    /// @param weightCutPercent The percent by which the weight decreases each cycle, out of
+    /// `JBConstants.MAX_WEIGHT_CUT_PERCENT`.
     /// @param approvalHook The approval hook for the ruleset.
     /// @param metadata The packed ruleset metadata.
     /// @param mustStartAtOrAfter The earliest time the ruleset can start.

package/src/interfaces/IJBTerminal.sol

@@ -107,9 +107,9 @@ interface IJBTerminal is IERC165 {
         returns (uint256);
 
     /// @notice Simulates paying a project through this terminal without modifying state.
-    /// @param projectId The ID of the project being paid.
-    /// @param token The token being paid in.
-    /// @param amount The amount of tokens being paid.
+    /// @param projectId The ID of the project to pay.
+    /// @param token The token to pay with.
+    /// @param amount The amount of tokens to pay.
     /// @param beneficiary The address to mint project tokens to.
     /// @param metadata Extra data to pass along to the data hook and pay hooks.
     /// @return ruleset The project's current ruleset.
@@ -139,8 +139,8 @@ interface IJBTerminal is IERC165 {
 
     /// @notice Adds funds to a project's balance.
     /// @param projectId The ID of the project to add funds to.
-    /// @param token The token being added.
-    /// @param amount The amount of tokens being added.
+    /// @param token The token added.
+    /// @param amount The amount of tokens added.
     /// @param shouldReturnHeldFees Whether held fees should be returned based on the amount added.
     /// @param memo A memo to pass along to the emitted event.
     /// @param metadata Extra data to pass along to the emitted event.
@@ -156,16 +156,16 @@ interface IJBTerminal is IERC165 {
         payable;
 
     /// @notice Migrates a project's funds from this terminal to another.
-    /// @param projectId The ID of the project being migrated.
-    /// @param token The address of the token being migrated.
+    /// @param projectId The ID of the project to migrate.
+    /// @param token The address of the token to migrate.
     /// @param to The terminal to migrate to.
     /// @return balance The amount of funds that were migrated.
     function migrateBalanceOf(uint256 projectId, address token, IJBTerminal to) external returns (uint256 balance);
 
     /// @notice Pays a project in a specified token.
-    /// @param projectId The ID of the project being paid.
-    /// @param token The token being paid in.
-    /// @param amount The amount of tokens being paid.
+    /// @param projectId The ID of the project to pay.
+    /// @param token The token to pay with.
+    /// @param amount The amount of tokens to pay.
     /// @param beneficiary The address to mint project tokens to.
     /// @param minReturnedTokens The minimum number of project tokens expected in return.
     /// @param memo A memo to pass along to the emitted event.