Improve Math.sol NatSpec documentation (#5813)

aviggiano · Amxx · web-flow · commit a909a7dca1ca · 2025-07-23T16:20:53.000+02:00
Co-authored-by: Hadrien Croubois &lt;hadrien.croubois@gmail.com&gt;
diff --git a/contracts/utils/math/Math.sol b/contracts/utils/math/Math.sol
@@ -134,10 +134,10 @@ library Math {
     }
 
     /**
-     * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
+     * @dev Branchless ternary evaluation for `condition ? a : b`. Gas costs are constant.
      *
      * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
-     * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
+     * However, the compiler may optimize Solidity ternary operations (i.e. `condition ? a : b`) to only compute
      * one branch when needed, making this function more expensive.
      */
     function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {

Original file line number	Diff line number	Diff line change
`@@ -134,10 +134,10 @@ library Math {`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`/**`
`137`		- * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
	`137`	+ * @dev Branchless ternary evaluation for `condition ? a : b`. Gas costs are constant.
`138`	`138`	`*`
`139`	`139`	`* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.`
`140`		- * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
	`140`	+ * However, the compiler may optimize Solidity ternary operations (i.e. `condition ? a : b`) to only compute
`141`	`141`	`* one branch when needed, making this function more expensive.`
`142`	`142`	`*/`
`143`	`143`	`function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {`