imp: added inline comments to the enum variant inserted by proc macro (…

…#66) * deps(derive): bumped to v0.4.2 * deps: bumped to v0.4.2 * test: improved testing contracts * docs: changelog updated
srdtrk · Jan 28, 2024 · ed62894 · ed62894
1 parent ef7cd26
commit ed62894
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.4.2 (2024-01-28)
+
+### Changes
+
+- Added inline documentation to the enum variant inserted by the proc macro introduced in `v0.4.1`. (https://github.com/srdtrk/cw-ica-controller/pull/66)
+
 ## v0.4.1 (2024-01-27)
 
 ### Features

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "cw-ica-controller"
-version = "0.4.1"
+version = "0.4.2"
 authors = ["srdtrk <[email protected]>"]
 edition = "2021"
 description = "This is a CosmWasm implementation of an ICS-27 interchain accounts controller."
@@ -58,7 +58,7 @@ thiserror = "1.0.50"
 cosmos-sdk-proto = { version = "0.20.0", default-features = false, features = ["cosmwasm"] }
 semver = "1.0"
 cw-ownable = "0.5.1"
-cw-ica-controller-derive = "0.4.1"
+cw-ica-controller-derive = "0.4.2"
 
 [dev-dependencies]
 base64 = "0.13.1"

diff --git a/derive/Cargo.toml b/derive/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "cw-ica-controller-derive"
 authors = ["srdtrk <[email protected]>"]
-version = "0.4.1"
+version = "0.4.2"
 edition = "2021"
 description = "This crate contains macros for deriving cw-ica-controller interfaces."
 repository = "https://github.com/srdtrk/cw-ica-controller"

diff --git a/derive/src/lib.rs b/derive/src/lib.rs
@@ -87,6 +87,9 @@ pub fn ica_callback_execute(metadata: TokenStream, input: TokenStream) -> TokenS
         input,
         quote! {
         enum Right {
+            /// The callback message from `cw-ica-controller`.
+            /// The handler for this variant should verify that this message comes from an
+            /// expected legitimate source.
             ReceiveIcaCallback(::cw_ica_controller::types::callbacks::IcaControllerCallbackMsg),
         }
         }

diff --git a/testing/contracts/callback-counter/Cargo.lock b/testing/contracts/callback-counter/Cargo.lock
diff --git a/testing/contracts/callback-counter/src/msg.rs b/testing/contracts/callback-counter/src/msg.rs
@@ -5,7 +5,9 @@ use cw_ica_controller::helpers::ica_callback_execute;
 pub struct InstantiateMsg {}
 
 #[ica_callback_execute]
+#[deny(missing_docs)]
 #[cw_serde]
+/// This is the execute message of the contract.
 pub enum ExecuteMsg {}
 
 #[cw_serde]

diff --git a/testing/contracts/cw-ica-owner/Cargo.lock b/testing/contracts/cw-ica-owner/Cargo.lock