Merge pull request #2265 from CosmWasm/mergify/bp/release/1.5/pr-2245

Document entry_point in cosmwasm-std instead of derive (backport #2245)

packages/derive/Cargo.toml

@@ -16,10 +16,3 @@ default = []
 
 [dependencies]
 syn = { version = "1.0", features = ["full"] }
-
-[dev-dependencies]
-# Needed for testing docs
-# "What's even more fun, Cargo packages actually can have cyclic dependencies.
-# "(a package can have an indirect dev-dependency on itself)"
-# https://users.rust-lang.org/t/does-cargo-support-cyclic-dependencies/35666/3
-cosmwasm-std = { path = "../std" }

packages/derive/src/lib.rs

@@ -4,53 +4,7 @@ extern crate syn;
 use proc_macro::TokenStream;
 use std::str::FromStr;
 
-/// This attribute macro generates the boilerplate required to call into the
-/// contract-specific logic from the entry-points to the Wasm module.
-///
-/// It should be added to the contract's init, handle, migrate and query implementations
-/// like this:
-/// ```
-/// # use cosmwasm_std::{
-/// #     Storage, Api, Querier, DepsMut, Deps, entry_point, Env, StdError, MessageInfo,
-/// #     Response, QueryResponse,
-/// # };
-/// #
-/// # type InstantiateMsg = ();
-/// # type ExecuteMsg = ();
-/// # type QueryMsg = ();
-///
-/// #[entry_point]
-/// pub fn instantiate(
-///     deps: DepsMut,
-///     env: Env,
-///     info: MessageInfo,
-///     msg: InstantiateMsg,
-/// ) -> Result<Response, StdError> {
-/// #   Ok(Default::default())
-/// }
-///
-/// #[entry_point]
-/// pub fn execute(
-///     deps: DepsMut,
-///     env: Env,
-///     info: MessageInfo,
-///     msg: ExecuteMsg,
-/// ) -> Result<Response, StdError> {
-/// #   Ok(Default::default())
-/// }
-///
-/// #[entry_point]
-/// pub fn query(
-///     deps: Deps,
-///     env: Env,
-///     msg: QueryMsg,
-/// ) -> Result<QueryResponse, StdError> {
-/// #   Ok(Default::default())
-/// }
-/// ```
-///
-/// where `InstantiateMsg`, `ExecuteMsg`, and `QueryMsg` are contract defined
-/// types that implement `DeserializeOwned + JsonSchema`.
+// function documented in cosmwasm-std
 #[proc_macro_attribute]
 pub fn entry_point(_attr: TokenStream, mut item: TokenStream) -> TokenStream {
     let cloned = item.clone();

packages/std/src/lib.rs

@@ -124,6 +124,51 @@ pub use crate::imports::{ExternalApi, ExternalQuerier, ExternalStorage};
 #[cfg(not(target_arch = "wasm32"))]
 pub mod testing;
 
-// Re-exports
-
+/// This attribute macro generates the boilerplate required to call into the
+/// contract-specific logic from the entry-points to the Wasm module.
+///
+/// It should be added to the contract's init, handle, migrate and query implementations
+/// like this:
+/// ```
+/// # use cosmwasm_std::{
+/// #     Storage, Api, Querier, DepsMut, Deps, entry_point, Env, StdError, MessageInfo,
+/// #     Response, QueryResponse,
+/// # };
+/// #
+/// # type InstantiateMsg = ();
+/// # type ExecuteMsg = ();
+/// # type QueryMsg = ();
+///
+/// #[entry_point]
+/// pub fn instantiate(
+///     deps: DepsMut,
+///     env: Env,
+///     info: MessageInfo,
+///     msg: InstantiateMsg,
+/// ) -> Result<Response, StdError> {
+/// #   Ok(Default::default())
+/// }
+///
+/// #[entry_point]
+/// pub fn execute(
+///     deps: DepsMut,
+///     env: Env,
+///     info: MessageInfo,
+///     msg: ExecuteMsg,
+/// ) -> Result<Response, StdError> {
+/// #   Ok(Default::default())
+/// }
+///
+/// #[entry_point]
+/// pub fn query(
+///     deps: Deps,
+///     env: Env,
+///     msg: QueryMsg,
+/// ) -> Result<QueryResponse, StdError> {
+/// #   Ok(Default::default())
+/// }
+/// ```
+///
+/// where `InstantiateMsg`, `ExecuteMsg`, and `QueryMsg` are contract defined
+/// types that implement `DeserializeOwned + JsonSchema`.
 pub use cosmwasm_derive::entry_point;