Skip to content
This repository has been archived by the owner on Oct 19, 2024. It is now read-only.

Commit

Permalink
fix: rustdoc nightly warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniPopes authored and gakonst committed Nov 7, 2022
1 parent dbc2128 commit 855d36a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ pub struct InternalStructs {
/// from ethabi.
pub(crate) function_params: HashMap<(String, String), String>,

/// (function name) -> Vec<structs> all structs the function returns
/// (function name) -> `Vec<structs>` all structs the function returns
pub(crate) outputs: HashMap<String, Vec<String>>,

/// (event name, idx) -> struct which are the identifying properties we get the name
Expand Down
2 changes: 1 addition & 1 deletion ethers-core/src/abi/human_readable/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub struct AbiParser {
///
/// Note: we need to map the index of the event here because events can contain nameless inputs
pub event_params: HashMap<(String, usize), String>,
/// (function name) -> Vec<structs> all structs the function returns
/// (function name) -> `Vec<structs>` all structs the function returns
pub outputs: HashMap<String, Vec<String>>,
}

Expand Down
2 changes: 1 addition & 1 deletion ethers-core/src/types/block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use thiserror::Error;

/// The block type returned from RPC calls.
/// This is generic over a `TX` type which will be either the hash or the full transaction,
/// i.e. `Block<TxHash>` or Block<Transaction>`.
/// i.e. `Block<TxHash>` or `Block<Transaction>`.
#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)]
pub struct Block<TX> {
/// Hash of the block
Expand Down
6 changes: 3 additions & 3 deletions ethers-solc/src/artifact_output/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,20 +62,20 @@ impl ArtifactId {
self
}

/// Returns a <filename>:<name> slug that identifies an artifact
/// Returns a `<filename>:<name>` slug that identifies an artifact
///
/// Note: This identifier is not necessarily unique. If two contracts have the same name, they
/// will share the same slug. For a unique identifier see [ArtifactId::identifier].
pub fn slug(&self) -> String {
format!("{}.json:{}", self.path.file_stem().unwrap().to_string_lossy(), self.name)
}

/// Returns a <source path>:<name> slug that uniquely identifies an artifact
/// Returns a `<source path>:<name>` slug that uniquely identifies an artifact
pub fn identifier(&self) -> String {
format!("{}:{}", self.source.to_string_lossy(), self.name)
}

/// Returns a <filename><version>:<name> slug that identifies an artifact
/// Returns a `<filename><version>:<name>` slug that identifies an artifact
pub fn slug_versioned(&self) -> String {
format!(
"{}.{}.{}.{}.json:{}",
Expand Down

0 comments on commit 855d36a

Please sign in to comment.