Improve docs on SubMsg.gas_limit

CosmWasm · Jan 29, 2024 · fec86fa · fec86fa
1 parent 481db54
commit fec86fa
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/contracts/reflect/schema/raw/execute.json b/contracts/reflect/schema/raw/execute.json
@@ -698,7 +698,7 @@
       ],
       "properties": {
         "gas_limit": {
-          "description": "Gas limit measured in [Cosmos SDK gas](https://github.com/CosmWasm/cosmwasm/blob/main/docs/GAS.md).",
+          "description": "Gas limit measured in [Cosmos SDK gas](https://github.com/CosmWasm/cosmwasm/blob/main/docs/GAS.md).\n\nSetting this to `None` means unlimited. Then the submessage execution can consume all gas of the current execution context.",
           "type": [
             "integer",
             "null"

diff --git a/contracts/reflect/schema/reflect.json b/contracts/reflect/schema/reflect.json
@@ -708,7 +708,7 @@
         ],
         "properties": {
           "gas_limit": {
-            "description": "Gas limit measured in [Cosmos SDK gas](https://github.com/CosmWasm/cosmwasm/blob/main/docs/GAS.md).",
+            "description": "Gas limit measured in [Cosmos SDK gas](https://github.com/CosmWasm/cosmwasm/blob/main/docs/GAS.md).\n\nSetting this to `None` means unlimited. Then the submessage execution can consume all gas of the current execution context.",
             "type": [
               "integer",
               "null"

diff --git a/packages/std/src/results/submessages.rs b/packages/std/src/results/submessages.rs
@@ -49,6 +49,9 @@ pub struct SubMsg<T = Empty> {
     pub payload: Binary,
     pub msg: CosmosMsg<T>,
     /// Gas limit measured in [Cosmos SDK gas](https://github.com/CosmWasm/cosmwasm/blob/main/docs/GAS.md).
+    ///
+    /// Setting this to `None` means unlimited. Then the submessage execution can consume all gas of the
+    /// current execution context.
     pub gas_limit: Option<u64>,
     pub reply_on: ReplyOn,
 }