From 9bdc84c552daa6c7589c1259cc2a1fb3f85296dd Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 7 Dec 2022 14:35:43 +0000 Subject: [PATCH] Update docs --- contracts/proxy/utils/Initializable.sol | 4 ++-- docs/modules/api/pages/proxy.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/contracts/proxy/utils/Initializable.sol b/contracts/proxy/utils/Initializable.sol index 1b57baf27..0a87d8c19 100644 --- a/contracts/proxy/utils/Initializable.sol +++ b/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; diff --git a/docs/modules/api/pages/proxy.adoc b/docs/modules/api/pages/proxy.adoc index 9df6a797d..748e8de52 100644 --- a/docs/modules/api/pages/proxy.adoc +++ b/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-]]