milksad
/
rust-bip39-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Fix refs to types in docs

This commit is contained in:
Steven Roose 2020-09-22 12:34:45 +02:00
parent dc4c9999ea
commit bc452184dc
No known key found for this signature in database
GPG Key ID: 2F2A88D7F8D68E87
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

@ -148,13 +148,13 @@ impl Mnemonic {
Ok(Mnemonic(words.join(" "))) Ok(Mnemonic(words.join(" ")))
} }
/// Create a new English [Mnemonic] in from the given entropy. /// Create a new English [Mnemonic] from the given entropy.
/// Entropy must be a multiple of 32 bits (4 bytes) and 128-256 bits in length. /// Entropy must be a multiple of 32 bits (4 bytes) and 128-256 bits in length.
pub fn from_entropy(entropy: &[u8]) -> Result<Mnemonic, Error> { pub fn from_entropy(entropy: &[u8]) -> Result<Mnemonic, Error> {
Mnemonic::from_entropy_in(Language::English, entropy) Mnemonic::from_entropy_in(Language::English, entropy)
} }
/// Generate a new Mnemonic in the given language. /// Generate a new [Mnemonic] in the given language.
/// For the different supported word counts, see documentation on [Mnemonoc]. /// For the different supported word counts, see documentation on [Mnemonoc].
#[cfg(feature = "rand")] #[cfg(feature = "rand")]
pub fn generate_in(language: Language, word_count: usize) -> Result<Mnemonic, Error> { pub fn generate_in(language: Language, word_count: usize) -> Result<Mnemonic, Error> {
@ -169,7 +169,7 @@ impl Mnemonic {
Mnemonic::from_entropy_in(language, &entropy) Mnemonic::from_entropy_in(language, &entropy)
} }
/// Generate a new Mnemonic in English. /// Generate a new [Mnemonic] in English.
/// For the different supported word counts, see documentation on [Mnemonoc]. /// For the different supported word counts, see documentation on [Mnemonoc].
#[cfg(feature = "rand")] #[cfg(feature = "rand")]
pub fn generate(word_count: usize) -> Result<Mnemonic, Error> { pub fn generate(word_count: usize) -> Result<Mnemonic, Error> {