From d66e2bc4565ed879928f922fa2d92f44616a7af0 Mon Sep 17 00:00:00 2001 From: yonada Date: Thu, 7 Mar 2024 14:27:32 +0000 Subject: [PATCH] docs(world): add natspec to module errors (#2390) --- packages/world/src/IModuleErrors.sol | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/packages/world/src/IModuleErrors.sol b/packages/world/src/IModuleErrors.sol index 393049dd0c..f0bfdeaa0b 100644 --- a/packages/world/src/IModuleErrors.sol +++ b/packages/world/src/IModuleErrors.sol @@ -9,9 +9,21 @@ pragma solidity >=0.8.24; * This ensures that all errors are included in the IWorldKernel ABI for proper decoding in the frontend. */ interface IModuleErrors { - /// @dev Errors to represent non-support of specific installation types. + /** + * @notice Error raised if installing in root is not supported. + */ error Module_RootInstallNotSupported(); + /** + * @notice Error raised if installing in non-root is not supported. + */ error Module_NonRootInstallNotSupported(); + /** + * @notice Error raised if the provided module is already installed. + */ error Module_AlreadyInstalled(); + /** + * @notice Error raised if the provided module is missing a dependency. + * @param dependency The address of the dependency. + */ error Module_MissingDependency(address dependency); }