Skip to content

Commit

Permalink
Remove mentions in code level docs
Browse files Browse the repository at this point in the history
  • Loading branch information
HCastano committed Feb 26, 2022
1 parent 5257364 commit bb5a83d
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 52 deletions.
4 changes: 0 additions & 4 deletions crates/lang/ir/src/ir/contract.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,6 @@ impl Contract {
///
/// - `types`: To specify `Environment` different from the default environment
/// types.
/// - `storage-alloc`: If `true` enables the dynamic storage allocator
/// facilities and code generation of the ink! smart
/// contract. Does incur some overhead. The default is
/// `true`.
/// - `as-dependency`: If `true` compiles this ink! smart contract always as
/// if it was a dependency of another smart contract.
/// This configuration is mainly needed for testing and
Expand Down
49 changes: 1 addition & 48 deletions crates/lang/macro/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,53 +119,6 @@ pub fn selector_bytes(input: TokenStream) -> TokenStream {
/// The `#[ink::contract]` macro can be provided with some additional comma-separated
/// header arguments:
///
/// - `dynamic_storage_allocator: bool`
///
/// Tells the ink! code generator to allow usage of ink!'s built-in dynamic
/// storage allocator.
/// - `true`: Use the dynamic storage allocator provided by ink!.
/// - `false`: Do NOT use the dynamic storage allocator provided by ink!.
///
/// This feature is generally only needed for smart contracts that try to model
/// their data in a way that contains storage entities within other storage
/// entities.
///
/// Contract writers should try to write smart contracts that do not depend on the
/// dynamic storage allocator since enabling it comes at a cost of increased Wasm
/// file size. Although it will enable interesting use cases. Use it with care!
///
/// An example for this is the following type that could potentially be used
/// within a contract's storage struct definition:
///
///
/// ```ignore
/// # // Tracking issue [#1119]: Right now we've hidden the `StorageVec` from public access so
/// # // this doesn't compile.
/// # use ink_storage as storage;
/// # type _unused =
/// storage::Vec<storage::Vec<i32>>
/// # ;
/// ```
///
/// **Usage Example:**
/// ```
/// # use ink_lang as ink;
/// #[ink::contract(dynamic_storage_allocator = true)]
/// mod my_contract {
/// # #[ink(storage)]
/// # pub struct MyStorage;
/// # impl MyStorage {
/// # #[ink(constructor)]
/// # pub fn construct() -> Self { MyStorage {} }
/// # #[ink(message)]
/// # pub fn message(&self) {}
/// # }
/// // ...
/// }
/// ```
///
/// **Default value:** `false`
///
/// - `compile_as_dependency: bool`
///
/// Tells the ink! code generator to **always** or **never**
Expand Down Expand Up @@ -710,7 +663,7 @@ pub fn contract(attr: TokenStream, item: TokenStream) -> TokenStream {
/// pub trait TraitDefinition {
/// #[ink(message)]
/// fn message1(&self);
///
///
/// #[ink(message, selector = 42)]
/// fn message2(&self);
/// }
Expand Down

0 comments on commit bb5a83d

Please sign in to comment.