Skip to content

Commit

Permalink
Add doc qualifying where contractimport is relative to (#1241)
Browse files Browse the repository at this point in the history
### What
Add doc qualifying where the path passed to contractimport is relative
to.

### Why
The docs don't say, and you could easily assume it is relative to the
current file which is what some built-in Rust macros do. The reason it
isn't relative to the current file is because Rust macros don't provide
anyway for a non-built-in macro to do that.
  • Loading branch information
leighmcculloch authored Mar 18, 2024
1 parent 9e2c302 commit 10018d8
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions soroban-sdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ pub use soroban_sdk_macros::contracterror;
/// Import a contract from its WASM file, generating a client, types, and
/// constant holding the contract file.
///
/// The path given is relative to the workspace root, and not the current
/// file.
///
/// Generates in the current module:
/// - A `Contract` trait that matches the contracts interface.
/// - A `ContractClient` struct that has functions for each function in the
Expand Down

0 comments on commit 10018d8

Please sign in to comment.