aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/twofactor.rst
diff options
context:
space:
mode:
authorJiangge Zhang <tonyseek@gmail.com>2015-06-03 17:30:11 +0800
committerJiangge Zhang <tonyseek@gmail.com>2015-06-03 17:39:59 +0800
commitd4e0a839ef676a2ed05140f98ef3630deb0fdd61 (patch)
tree4786265848ce18dbda22f6daa3b3a28e6c48d561 /docs/hazmat/primitives/twofactor.rst
parente9f8eb9af0c4f42dd4e68ae05580f77dc352aaf4 (diff)
downloadcryptography-d4e0a839ef676a2ed05140f98ef3630deb0fdd61.tar.gz
cryptography-d4e0a839ef676a2ed05140f98ef3630deb0fdd61.tar.bz2
cryptography-d4e0a839ef676a2ed05140f98ef3630deb0fdd61.zip
Remove a default argument and rename a private function.
Diffstat (limited to 'docs/hazmat/primitives/twofactor.rst')
-rw-r--r--docs/hazmat/primitives/twofactor.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/hazmat/primitives/twofactor.rst b/docs/hazmat/primitives/twofactor.rst
index dace6f7d..016c30eb 100644
--- a/docs/hazmat/primitives/twofactor.rst
+++ b/docs/hazmat/primitives/twofactor.rst
@@ -74,11 +74,12 @@ codes (HMAC).
:raises cryptography.hazmat.primitives.twofactor.InvalidToken: This
is raised when the supplied HOTP does not match the expected HOTP.
- .. method:: get_provisioning_uri(account_name, counter, issuer=None)
+ .. method:: get_provisioning_uri(account_name, counter, issuer)
:param str account_name: The display name of account, such as
``'Alice Smith'`` or ``'alice@example.com'``.
- :param str issuer: The optional display name of issuer.
+ :param issuer: The optional display name of issuer.
+ :type issuer: `string` or `None`
:param int counter: The current value of counter.
:return str: An URI string.
@@ -180,11 +181,12 @@ similar to the following code.
:raises cryptography.hazmat.primitives.twofactor.InvalidToken: This
is raised when the supplied TOTP does not match the expected TOTP.
- .. method:: get_provisioning_uri(account_name, issuer=None)
+ .. method:: get_provisioning_uri(account_name, issuer)
:param str account_name: The display name of account, such as
``'Alice Smith'`` or ``'alice@example.com'``.
- :param str issuer: The optional display name of issuer.
+ :param issuer: The optional display name of issuer.
+ :type issuer: `string` or `None`
:return str: An URI string.
Provisioning URI