pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-27 01:07:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixing return types in crypto module documentation (#14554)

Browse Source 
* fixing return types in documentation

* Apply suggestions from code review

---------

Co-authored-by: Bastian Köcher <git@kchr.de>
This commit is contained in:
Jacob T Firek
2023-07-14 12:39:07 -07:00
committed by GitHub
parent e8a9559696
commit d4ad997deb
1 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/primitives/core/src/crypto.rs
+2 -4
View File
@@ -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,
@@ -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.
@@ -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,