From 36b9624b77d6018fedf2c68065aee3fec24deb61 Mon Sep 17 00:00:00 2001
From: ulif <uli@gnufix.de>
Date: Thu, 29 Jan 2015 12:23:19 +0100
Subject: [PATCH] More docs.
---
diceware/diceware.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/diceware/diceware.py b/diceware/diceware.py
index 5bffc23..9a313d2 100644
--- a/diceware/diceware.py
+++ b/diceware/diceware.py
@@ -83,6 +83,14 @@ def insert_special_char(word, specials=SPECIAL_CHARS, rnd=None):
def get_passphrase(wordnum=6, specialsnum=1, delimiter='', lang='en',
capitalized=True):
"""Get a diceware passphrase.
+
+ The passphrase returned will contain `wordnum` words deliimted by
+ `delimiter`.
+
+ If `capitalized` is ``True``, all words will be capitalized.
+
+ The wordlist to pick words from is determined by `lang`,
+ representing a language.
"""
word_list = get_wordlist(get_wordlist_path(lang))
rnd = SystemRandom()
--
GitLab