docs(abigen): improve abigen type docs (#953)

* docs(abigen): improve abigen type docs

* Update ethers-contract/ethers-contract-abigen/src/lib.rs

Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
This commit is contained in:
Matthias Seitz 2022-02-23 11:36:14 +01:00 committed by GitHub
parent d22b2c1a9c
commit 9876b49e6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions

View File

@ -37,10 +37,13 @@ use std::{collections::HashMap, fs::File, io::Write, path::Path};
/// [still not supported by Vyper](https://github.com/vyperlang/vyper/issues/1931), so you must adjust your ABIs and replace /// [still not supported by Vyper](https://github.com/vyperlang/vyper/issues/1931), so you must adjust your ABIs and replace
/// `constant` functions with `view` or `pure`. /// `constant` functions with `view` or `pure`.
/// ///
/// To generate bindings for _multiple_ contracts at once see also [`crate::MultiAbigen`].
///
/// # Example /// # Example
/// ///
/// Running the command below will generate a file called `token.rs` containing the /// Running the code below will generate a file called `token.rs` containing the
/// bindings inside, which exports an `ERC20Token` struct, along with all its events. /// bindings inside, which exports an `ERC20Token` struct, along with all its events. Put into a
/// `build.rs` file this will generate the bindings during `cargo build`.
/// ///
/// ```no_run /// ```no_run
/// # use ethers_contract_abigen::Abigen; /// # use ethers_contract_abigen::Abigen;