Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

fixing return types in crypto module documentation #14554

Merged
merged 2 commits into from
Jul 14, 2023
Merged

fixing return types in crypto module documentation #14554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5963bfe
fixing return types in documentation
jtfirek Jul 11, 2023
323ac6b
Apply suggestions from code review
bkchr Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions primitives/core/src/crypto.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ pub trait Pair: CryptoType + Sized + Clone + Send + Sync + 'static {
(pair, phrase.to_owned(), seed)
}

/// Returns the KeyPair from the English BIP39 seed `phrase`, or `None` if it's invalid.
/// Returns the KeyPair from the English BIP39 seed `phrase`, or an error if it's invalid.
#[cfg(feature = "std")]
fn from_phrase(
phrase: &str,
Expand Down Expand Up @@ -907,7 +907,7 @@ pub trait Pair: CryptoType + Sized + Clone + Send + Sync + 'static {
}

/// Make a new key pair from secret seed material. The slice must be the correct size or
/// it will return `None`.
/// an error will be returned.
///
/// @WARNING: THIS WILL ONLY BE SECURE IF THE `seed` IS SECURE. If it can be guessed
/// by an attacker then they can also derive your key.
Expand Down Expand Up @@ -949,8 +949,6 @@ pub trait Pair: CryptoType + Sized + Clone + Send + Sync + 'static {
/// Notably, integer junction indices may be legally prefixed with arbitrary number of zeros.
/// Similarly an empty password (ending the SURI with `///`) is perfectly valid and will
/// generally be equivalent to no password at all.
///
/// `None` is returned if no matches are found.
#[cfg(feature = "std")]
fn from_string_with_seed(
s: &str,
Expand Down