iskm/wordfreq
1
0
Fork 0
mirror of https://github.com/rspeer/wordfreq.git synced 2024-12-23 09:21:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

clearified the docstrings for random_words and random_ascii_words

Browse Source
This commit is contained in:
Joshua Chin 2015-06-17 14:26:06 -04:00
parent 9f288bac31
commit a289ab7f8b
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
wordfreq/__init__.py
View File

@ -122,7 +122,7 @@ def get_frequency_list(lang, wordlist='combined', match_cutoff=30):
"nearest match, which is %r (%s)."
% (lang, best, langcodes.get(best).language_name('en'))
)
return read_dBpack(available[best])
@ -233,8 +233,9 @@ def random_words(lang='en', wordlist='combined', nwords=4, bits_per_word=12,
These words are are of the given language and from the given wordlist.
There are a total of nwords words in the string.
bits_pre_words is an estimate of the entropy provided by each word.
If ascii_only, then the words are ascii only.
bits_per_word is an estimate of the entropy provided by each word.
You can restrict the selection of words to those written in ASCII
characters by setting ascii_only to True.
"""
n_choices = 2 ** bits_per_word
choices = top_n_list(lang, n_choices, wordlist, ascii_only=ascii_only)
@ -254,7 +255,6 @@ def random_ascii_words(lang='en', wordlist='combined', nwords=4,
These words are are of the given language and from the given wordlist.
There are a total of nwords words in the string.
bits_pre_words is an estimate of the entropy provided by each word.
If ascii_only, then the words are ascii only.
bits_per_word is an estimate of the entropy provided by each word.
"""
return random_words(lang, wordlist, nwords, bits_per_word, ascii_only=True)