Merge pull request #115 from farismln/fix/two-steps-transfer-ownership-natspec

mudgen · web-flow · commit 3615bc2f0285 · 2025-10-26T02:06:07.000-04:00
Fix natspec for clarity about two-step transfer ownership
diff --git a/src/access/OwnerTwoSteps/LibOwnerTwoSteps.sol b/src/access/OwnerTwoSteps/LibOwnerTwoSteps.sol
@@ -48,7 +48,7 @@ library LibOwnerTwoSteps {
     }
 
     /// @notice Initiates a two-step ownership transfer.
-    /// @param _newOwner The address of the new owner (set to `address(0)` to renounce).
+    /// @param _newOwner The address of the new owner of the contract
     function transferOwnership(address _newOwner) internal {
         OwnerTwoStepsStorage storage s = getStorage();
         s.pendingOwner = _newOwner;
diff --git a/src/access/OwnerTwoSteps/OwnerTwoSteps.sol b/src/access/OwnerTwoSteps/OwnerTwoSteps.sol
@@ -42,7 +42,6 @@ contract OwnerTwoStepsFacet {
     }
 
     /// @notice Set the address of the new owner of the contract
-    /// @dev Set _newOwner to address(0) to renounce any ownership.
     /// @param _newOwner The address of the new owner of the contract
     function transferOwnership(address _newOwner) external {
         OwnerTwoStepsStorage storage s = getStorage();

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ library LibOwnerTwoSteps {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/// @notice Initiates a two-step ownership transfer.`
`51`		- /// @param _newOwner The address of the new owner (set to `address(0)` to renounce).
	`51`	`+ /// @param _newOwner The address of the new owner of the contract`
`52`	`52`	`function transferOwnership(address _newOwner) internal {`
`53`	`53`	`OwnerTwoStepsStorage storage s = getStorage();`
`54`	`54`	`s.pendingOwner = _newOwner;`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,6 @@ contract OwnerTwoStepsFacet {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/// @notice Set the address of the new owner of the contract`
`45`		`- /// @dev Set _newOwner to address(0) to renounce any ownership.`
`46`	`45`	`/// @param _newOwner The address of the new owner of the contract`
`47`	`46`	`function transferOwnership(address _newOwner) external {`
`48`	`47`	`OwnerTwoStepsStorage storage s = getStorage();`