Skip to content

Commit

Permalink
Better Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
0xIchigo committed May 6, 2024
1 parent f6285bb commit 8be6118
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/enhanced_transactions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ impl Helius {
}

/// Retrieves a parsed transaction history for a specific address
///
///
/// # Arguments
/// * `address` - An address for which a given parsed transaction history will be retrieved
///
///
/// # Returns
/// A `Result` wrapping a vector of `EnhancedTransaction`s
pub async fn parsed_transaction_history(&self, address: &str) -> Result<Vec<EnhancedTransaction>> {
Expand Down
4 changes: 2 additions & 2 deletions src/utils/deserialize_str_to_number.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ use serde::{Deserialize, Deserializer};
use serde_json::{Number, Value};

/// Deserializes a `String` to a `Number`
///
///
/// # Arguments
/// * `deserializer` - The deserializer instance from which to read the JSON value
///
///
/// # Returns a `Result` that is:
/// - `Ok(Number)` when the input is either a valid `Number` string or a JSON `Number`
/// - `Err(D::Error)` when there's an error from the deserializer if the input is neither a stringified number nor a direct `Number`,
Expand Down
4 changes: 2 additions & 2 deletions src/utils/is_valid_solana_address.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ use solana_sdk::pubkey::Pubkey;
use std::str::FromStr;

/// Checks whether a given string slice is a valid Solana address
///
///
/// # Arguments
/// * `address` - A string slice representing an address to validate
///
///
/// # Returns
/// `true` if the input is a valid Solana address based on the following criteria:
/// - Have a length between 32 and 44 characters, inclusive
Expand Down

0 comments on commit 8be6118

Please sign in to comment.