diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2015-06-04 06:38:11 -0400 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2015-06-04 06:38:11 -0400 |
| commit | 76806eee9b1ab4b397eedcb8696da651539a658b (patch) | |
| tree | 80e6c6544eb796bc5e77536b2bdd7d84bb7ea967 | |
| parent | d3532d4dc0f7a09efbf98890eba07a45e500f66a (diff) | |
| parent | 724617c44784954dc435a986481320caccc77a43 (diff) | |
| download | cryptography-76806eee9b1ab4b397eedcb8696da651539a658b.tar.gz cryptography-76806eee9b1ab4b397eedcb8696da651539a658b.tar.bz2 cryptography-76806eee9b1ab4b397eedcb8696da651539a658b.zip | |
Merge pull request #2005 from reaperhulk/fix-2004
some docs cleanup for OTP
| -rw-r--r-- | docs/hazmat/primitives/twofactor.rst | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/docs/hazmat/primitives/twofactor.rst b/docs/hazmat/primitives/twofactor.rst index f49d02f9..df70a58a 100644 --- a/docs/hazmat/primitives/twofactor.rst +++ b/docs/hazmat/primitives/twofactor.rst @@ -76,12 +76,15 @@ codes (HMAC). .. method:: get_provisioning_uri(account_name, counter, issuer) - :param str account_name: The display name of account, such as + :param account_name: The display name of account, such as ``'Alice Smith'`` or ``'alice@example.com'``. - :param issuer: The optional display name of issuer. - :type issuer: `string` or `None` + :type account_name: :term:`text` + :param issuer: The optional display name of issuer. This is typically + the provider or service the user wants to access using the OTP + token. + :type issuer: :term:`text` or `None` :param int counter: The current value of counter. - :return str: An URI string. + :return: A URI string. Throttling ~~~~~~~~~~ @@ -183,11 +186,14 @@ similar to the following code. .. method:: get_provisioning_uri(account_name, issuer) - :param str account_name: The display name of account, such as + :param account_name: The display name of account, such as ``'Alice Smith'`` or ``'alice@example.com'``. - :param issuer: The optional display name of issuer. - :type issuer: `string` or `None` - :return str: An URI string. + :type: :term:`text` + :param issuer: The optional display name of issuer. This is typically + the provider or service the user wants to access using the OTP + token. + :type issuer: :term:`text` or `None` + :return: A URI string. Provisioning URI ~~~~~~~~~~~~~~~~ |