Improve documentation in UUPSUpgradeable (#3606)

Amxx · web-flow · commit ca6f95a7dae5 · 2022-08-10T11:15:08.000+02:00
diff --git a/contracts/proxy/utils/UUPSUpgradeable.sol b/contracts/proxy/utils/UUPSUpgradeable.sol
@@ -46,7 +46,7 @@ abstract contract UUPSUpgradeable is IERC1822Proxiable, ERC1967Upgrade {
 
     /**
      * @dev Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the
-     * implementation. It is used to validate that the this implementation remains valid after an upgrade.
+     * implementation. It is used to validate the implementation's compatibility when performing an upgrade.
      *
      * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
      * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ abstract contract UUPSUpgradeable is IERC1822Proxiable, ERC1967Upgrade {`
`46`	`46`
`47`	`47`	`/**`
`48`	`48`	`* @dev Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the`
`49`		`- * implementation. It is used to validate that the this implementation remains valid after an upgrade.`
	`49`	`+ * implementation. It is used to validate the implementation's compatibility when performing an upgrade.`
`50`	`50`	`*`
`51`	`51`	`* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks`
`52`	`52`	`* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this`