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

Fix Mnemonic::language_of docs

This commit is contained in:
Steven Roose 2020-07-20 13:47:33 +02:00
parent dabbdce4d5
commit 0ecb12d399
No known key found for this signature in database
GPG Key ID: 2F2A88D7F8D68E87
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

@ -219,7 +219,11 @@ impl Mnemonic {
Ok(()) Ok(())
} }
/// Determine the language of the mnemonic based on the first word. /// Determine the language of the mnemonic.
///
/// NOTE: This method only guarantees that the returned language is the
/// correct language on the assumption that the mnemonic is valid.
/// It does not itself validate the mnemonic.
/// ///
/// Some word lists don't guarantee that their words don't occur in other /// Some word lists don't guarantee that their words don't occur in other
/// word lists. In the extremely unlikely case that a word list can be /// word lists. In the extremely unlikely case that a word list can be