Browse Source

Update docs

github-actions 2 years ago
parent
commit
9bdc84c552
2 changed files with 4 additions and 4 deletions
  1. 2 2
      contracts/proxy/utils/Initializable.sol
  2. 2 2
      docs/modules/api/pages/proxy.adoc

+ 2 - 2
contracts/proxy/utils/Initializable.sol

@@ -150,14 +150,14 @@ abstract contract Initializable {
     }
 
     /**
-     * @dev Internal function that returns the initialized version. Returns `_initialized`
+     * @dev Returns the highest version that has been initialized. See {reinitializer}.
      */
     function _getInitializedVersion() internal view returns (uint8) {
         return _initialized;
     }
 
     /**
-     * @dev Internal function that returns the initialized version. Returns `_initializing`
+     * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
      */
     function _isInitializing() internal view returns (bool) {
         return _initializing;

+ 2 - 2
docs/modules/api/pages/proxy.adoc

@@ -1226,13 +1226,13 @@ Emits an {Initialized} event the first time it is successfully executed.
 [[Initializable-_getInitializedVersion--]]
 ==== `[.contract-item-name]#++_getInitializedVersion++#++() → uint8++` [.item-kind]#internal#
 
-Internal function that returns the initialized version. Returns `_initialized`
+Returns the highest version that has been initialized. See {reinitializer}.
 
 [.contract-item]
 [[Initializable-_isInitializing--]]
 ==== `[.contract-item-name]#++_isInitializing++#++() → bool++` [.item-kind]#internal#
 
-Internal function that returns the initialized version. Returns `_initializing`
+Returns `true` if the contract is currently initializing. See {onlyInitializing}.
 
 [.contract-item]
 [[Initializable-Initialized-uint8-]]