diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/ec.rst | 2 | ||||
| -rw-r--r-- | docs/hazmat/primitives/twofactor.rst | 12 | ||||
| -rw-r--r-- | docs/x509/ocsp.rst | 6 | ||||
| -rw-r--r-- | docs/x509/reference.rst | 4 |
4 files changed, 11 insertions, 13 deletions
diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index ab781e92..226dea8c 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -455,7 +455,7 @@ Key Interfaces .. attribute:: name - :type: string + :type: str The name of the curve. Usually the name used for the ASN.1 OID such as ``secp256k1``. diff --git a/docs/hazmat/primitives/twofactor.rst b/docs/hazmat/primitives/twofactor.rst index 3b4f3961..b48db599 100644 --- a/docs/hazmat/primitives/twofactor.rst +++ b/docs/hazmat/primitives/twofactor.rst @@ -212,7 +212,7 @@ similar to the following code. :param account_name: The display name of account, such as ``'Alice Smith'`` or ``'alice@example.com'``. - :type: :term:`text` + :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. @@ -222,11 +222,11 @@ similar to the following code. Provisioning URI ~~~~~~~~~~~~~~~~ -The provisioning URI of HOTP and TOTP is not actual the part of RFC 4226 and -RFC 6238, but a `spec of Google Authenticator`_. It is widely supported by web -sites and mobile applications which are using Two-Factor authentication. +The provisioning URI of HOTP and TOTP is a `feature of Google Authenticator`_ +and not actually part of the HOTP or TOTP RFCs. However, it is widely supported +by web sites and mobile applications which are using Two-Factor authentication. -For generating a provisioning URI, you could use the ``get_provisioning_uri`` +For generating a provisioning URI you can use the ``get_provisioning_uri`` method of HOTP/TOTP instances. .. code-block:: python @@ -241,5 +241,5 @@ method of HOTP/TOTP instances. A common usage is encoding the provisioning URI into QR code and guiding users to scan it with Two-Factor authentication applications in their mobile devices. -.. _`spec of Google Authenticator`: https://github.com/google/google-authenticator/wiki/Key-Uri-Format +.. _`feature of Google Authenticator`: https://github.com/google/google-authenticator/wiki/Key-Uri-Format .. _`Issue #2915`: https://github.com/pyca/cryptography/issues/2915 diff --git a/docs/x509/ocsp.rst b/docs/x509/ocsp.rst index 163a6a8a..14d9bb84 100644 --- a/docs/x509/ocsp.rst +++ b/docs/x509/ocsp.rst @@ -178,8 +178,7 @@ Interfaces .. attribute:: hash_algorithm - :type: An instance of a - :class:`~cryptography.hazmat.primitives.hashes.Hash` + :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` The algorithm used to generate the ``issuer_key_hash`` and ``issuer_name_hash``. @@ -358,8 +357,7 @@ Interfaces .. attribute:: hash_algorithm - :type: An instance of a - :class:`~cryptography.hazmat.primitives.hashes.Hash` + :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` The algorithm used to generate the ``issuer_key_hash`` and ``issuer_name_hash``. diff --git a/docs/x509/reference.rst b/docs/x509/reference.rst index 079fef92..8330b2ac 100644 --- a/docs/x509/reference.rst +++ b/docs/x509/reference.rst @@ -1371,7 +1371,7 @@ General Name Classes .. attribute:: value - :type: `bytes` + :type: bytes X.509 Extensions ~~~~~~~~~~~~~~~~ @@ -2261,7 +2261,7 @@ X.509 Extensions .. attribute:: value - :type: byte + :type: bytes Returns the DER encoded bytes payload of the extension. |