chore: Improve docstrings

Took 23 minutes
This commit is contained in:
Diana Carvalho
2025-05-26 10:27:09 +01:00
parent c62af2f232
commit f5d9ab03da
4 changed files with 4 additions and 10 deletions

View File

@@ -149,7 +149,7 @@ impl Permit2 {
))),
}
}
/// Creates permit single and signature
/// Creates permit single
pub fn get_permit(
&self,
spender: &Bytes,

View File

@@ -65,6 +65,9 @@ impl TychoRouterEncoderBuilder {
self
}
/// Sets the `signer` for the encoder. This is used to sign permit2 objects. This is only needed
/// if you intend to get the full calldata for the transfer. We do not recommend using this
/// option, you should sign and create the function calldata entirely on your own.
pub fn signer(mut self, signer: PrivateKeySigner) -> Self {
self.signer = Some(signer);
self

View File

@@ -271,7 +271,6 @@ impl TychoEncoder for TychoRouterEncoder {
///
/// # Fields
/// * `swap_encoder_registry`: Registry of swap encoders
/// * `native_address`: Address of the chain's native token
#[derive(Clone)]
pub struct TychoExecutorEncoder {
swap_encoder_registry: SwapEncoderRegistry,